Getting Started

Relevant source files

• APIJSONORM/README.md
• APIJSONORM/pom.xml
• APIJSONORM/src/main/java/apijson/Log.java

Purpose and Scope

This page covers the foundational setup for integrating and running the APIJSON ORM library (APIJSONORM). It details adding remote dependencies via Maven and Gradle, building the project, configuring application logging through apijson.Log, and initializing the runtime environment.

Sources: APIJSONORM/pom.xml:1-61 APIJSONORM/pom.xml1-61 APIJSONORM/README.md:1-51 APIJSONORM/README.md1-51

---

1. Dependency Configuration

APIJSONORM is hosted via JitPack. To pull the library into your project, you must register the JitPack repository and add the APIJSON artifact dependency.

Maven Configuration

Add the JitPack repository and the APIJSON dependency to your pom.xml:

Gradle Configuration

Add the JitPack repository to your root build.gradle and the dependency to your module's build.gradle:

Sources: APIJSONORM/README.md:1-51 APIJSONORM/README.md1-51 APIJSONORM/pom.xml:6-30 APIJSONORM/pom.xml6-30

---

2. Building with Maven

The APIJSONORM library targets Java 1.8 and relies on the maven-compiler-plugin and maven-source-plugin for compilation and packaging.

To build the project locally, execute the standard Maven lifecycle command:

The build configuration specifies UTF-8 source encoding, Java 1.8 compatibility, and includes unit testing dependencies (junit:junit:4.13.2 under test scope).

Sources: APIJSONORM/pom.xml:14-58 APIJSONORM/pom.xml14-58

---

3. Running the Demo Server

While APIJSONORM provides the core ORM execution engine, web servers (such as Spring Boot or Apollo-based starters) wrap the parser to expose HTTP endpoints. To start a demo server:

1. Configure your database connection properties (e.g., URL, username, password) in your application's data source configuration.
2. Initialize the global parser creator and database executors.
3. Boot the application container, exposing endpoints that forward HTTP payloads into APIJSON's request processing pipeline.

Sources: APIJSONORM/pom.xml:1-61 APIJSONORM/pom.xml1-61

---

4. Logging Configuration via apijson.Log

Runtime diagnostics and execution logs are controlled via the apijson.Log utility class. By default, debug output is disabled, and logging defaults to the WARN level.

Key Configuration Properties and Methods

• Log.DEBUG: A boolean flag determining whether debug, verbose, info, error, and warning logs are emitted. Set Log.DEBUG = true; during development.
• Log.LEVEL: Defines the threshold level (LEVEL_VERBOSE, LEVEL_INFO, LEVEL_DEBUG, LEVEL_WARN, LEVEL_ERROR).
• Log.setDateFormat(String): Customizes the timestamp pattern used in log entries (default is yyyy-MM-dd hh:mm:ss.SSS).
• Logging methods: d(), v(), i(), w(), e(), and fd() (forced debug).

Sources: APIJSONORM/src/main/java/apijson/Log.java:13-151 APIJSONORM/src/main/java/apijson/Log.java13-151