Mastering API Full Lifecycle: From Object Modeling to Service Orchestration

API Full Lifecycle Management

The API lifecycle covers development, runtime, and operations, with the API gateway focusing on runtime concerns while the API development platform handles design, protocol conversion, and data mapping, ultimately exposing standard HTTP APIs that are registered with the gateway.

Subsystem Overview

The lifecycle is divided into four subsystems: API Development Platform, API Gateway Engine, API Monitoring & Operations Platform, and API Full‑Lifecycle Management Platform.

Traditional ESB adapters and protocol conversion are shifted to the rapid API development platform, which registers standard API services with the gateway. Monitoring collects logs for performance and analysis.

Object‑Driven Modeling

Core ideas rely on object‑driven modeling to decouple interfaces from underlying databases, supporting multiple databases and tables. Instead of directly exposing CRUD APIs from tables, objects are modeled first, enabling richer composition and rule extensions.

Object Modeling and API Contract

Objects are defined as hierarchical tree structures, generating multiple database tables. Defined objects automatically produce standard POST, GET, DELETE endpoints and can export contract files such as RAML, YAML, or WADL. The modeling tool can also generate client SDKs and server stubs for various languages.

Object Adaptation to Database

Objects can be mapped to one or more database tables, handling field mapping and primary‑foreign key relationships. After mapping, the API endpoints become usable.

API Interface Publishing

Developers select which API operations to expose (e.g., query, insert). Input message headers (e.g., user, token) and output error codes are predefined. Testing tools allow online simulation and saving of test cases.

API Documentation Generation

Documentation can be auto‑generated via integration with tools like Swagger.

Common Object Operations

Typical operations include create, update by primary key, query, and delete. Open‑source tools like npm install -g xmysql can expose an entire MySQL schema as REST APIs.

npm install -g xmysql
xmysql -h localhost -u mysqlUsername -p mysqlPassword -d databaseName
http://localhost:3000

Direct API Definition and Publishing

Beyond object‑driven APIs, custom methods, dynamic SQL, stored procedures, and JAR‑based functions can be bound to HTTP endpoints, enabling low‑code extensions.

Rule Processing

Input data integrity validation (type, length, range).

Data item rule handling (mapping, enrichment, truncation).

Custom scripting for low‑code rule extensions.

Message header and output field conventions for security and routing.

Service Composition and Orchestration

The platform supports visual service composition, allowing multiple atomic services (A, B, C) to be combined into a new service D, handling parallel or sequential execution, result merging, and data enrichment.

Examples include aggregating contract information from several queries, joining material and purchase order data from separate databases, and chaining validation, budgeting, and import services for contract processing.

Source Code Export

The platform can export compilable source code for generated APIs, with extension points for custom business logic before and after the core implementation.

//BeforeDo();
//ProcessAPI();
//AfterDo();

Microservice Application

Multiple objects or APIs can be packaged into a microservice JAR for deployment, either hosted on the platform or deployed independently.