Anonymous View
This guide provides a high-level technical introduction to using APIJSON for both backend and frontend developers. It covers the essential steps to set up an APIJSON server, integrate client SDKs, and execute your first API requests.
APIJSON is a real-time, no-code ORM and JSON transmission protocol that allows clients to customize response structures without backend code changes README.md10 For detailed protocol specifications, see APIJSON Protocol. For information about the internal architecture, see Core ORM Architecture.
Sources: README.md1-18 APIJSONORM/pom.xml1-12
The following diagram illustrates how various client applications interact with the APIJSON reference implementation through the standardized protocol layer, bridging high-level client actions to internal code entities.
APIJSON follows a universal pattern: clients send JSON requests via HTTP POST to standardized endpoints. The server's AbstractParser orchestrates request processing, delegating to AbstractVerifier for security validation and AbstractSQLExecutor for database interaction. Multi-language support is provided for various runtimes including Go, PHP, Node.js, Python, Rust, and C# README.md59-65
Sources: README.md58-67 README.md10
Backend setup involves configuring the APIJSON library within a Java-based server (Spring Boot, JFinal, etc.) and initializing the necessary system tables.
To set up a custom server, developers typically extend core classes from the apijson.orm package:
AbstractSQLConfig: Define database connections, table mapping, and SQL dialect behavior.AbstractParser: The main entry point for parsing incoming JSON requests.AbstractVerifier: Handles authentication and structural validation via the Access and Request tables.APIJSON is managed as a Maven project APIJSONORM/pom.xml1-12 It can be integrated into your project by adding the dependency to your pom.xml. The current version is 8.1.8 APIJSONORM/pom.xml8 APIJSONORM/src/main/java/apijson/Log.java15
For a step-by-step guide on dependency management and initialization, see Backend Setup.
Sources: README.md19-58 APIJSONORM/pom.xml1-55 APIJSONORM/src/main/java/apijson/Log.java13-36
Creating your first request demonstrates the power of the APIJSON protocol. A simple request for a User object defines the structure and constraints in JSON.
The following diagram bridges the natural language "Get User" to the specific code entities that process the request.
This sequence shows how the AbstractParser uses AbstractSQLConfig to build a query and AbstractSQLExecutor to fetch data from the Database_Server. The system allows frontend developers to customize response JSONs directly without backend intervention README.md10 Developers can use the Log class to debug the internal flow by setting Log.DEBUG = true APIJSONORM/src/main/java/apijson/Log.java14
For a complete walkthrough of CRUD operations and complex joins, see Your First API Request.
Sources: README.md10 APIJSONORM/src/main/java/apijson/Log.java13-77