Mastering API Full Lifecycle: From Object Modeling to Service Orchestration

API lifecycle management covers development, runtime, and operations. While an API gateway should remain lightweight and handle only runtime concerns, heavy tasks such as protocol conversion, data mapping, and interface generation belong to an API development platform that registers standard HTTP APIs with the gateway.

Subsystems of Full Lifecycle Management

The architecture can be divided into four subsystems:

API Development Platform

API Gateway Engine

API Monitoring & Operations Platform

API Lifecycle Management Portal

Traditional ESB adapters and protocol conversion are shifted to the development platform, which exposes standard API services and registers them with the gateway. The monitoring platform collects logs for performance and error analysis.

Object‑Driven Modeling

The core idea is to base API generation on object modeling. By defining objects, the platform automatically creates corresponding database tables, decouples schema, and supports multiple databases. Objects are hierarchical tree structures; a single object can generate several tables, and existing data can be combined into composite objects.

From an object definition the platform can generate standard CRUD endpoints (POST, GET, DELETE, etc.) and export contract files such as RAML, YAML, or WADL. It can also produce client SDKs and server stubs for various languages, similar to Swagger.

Object‑to‑Database Mapping

After modeling, objects are mapped to database tables, handling primary‑foreign key relationships. Once mapping is complete, the generated APIs become usable.

API Publishing

Developers can choose which operations to expose—e.g., only query endpoints or data‑import POST endpoints—and configure the data items that each API publishes. Input message headers (e.g., user, token) and output error fields are predefined for consistency.

Testing and Documentation

An integrated online testing tool allows developers to simulate API calls, save test cases, and verify behavior. Documentation can be auto‑generated by integrating open‑source tools like Swagger.

Common Object Operations

Typical CRUD operations include creating a record, updating by primary key, querying, and deleting. The open‑source tool xmysql can expose an entire MySQL database as REST APIs:

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

Note that this tool lacks built‑in permission control and is intended for testing and reference.

Rule Processing

Input data integrity validation (type, length, range)

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

Custom scripting for low‑code extensions

Message header and output field conventions

Service Composition and Orchestration

The platform also supports service composition, allowing multiple atomic services to be combined into new composite services. Examples include:

Aggregating query results from services A, B, C into a single response.

Merging data from separate services (e.g., material info and purchase order details) into a unified result set.

Chaining services where the output of one becomes the input of the next.

Enriching or trimming existing services to produce new outputs.

Combining multiple import services into a single bulk import operation.

These scenarios illustrate parallel vs. sequential execution, data merging, and visual orchestration challenges.

Source Code Export

For complex business rules, developers can export the generated source code, which should compile and run independently of the platform. Exported code can include extension points for future API changes.

Microservice Packaging

Multiple objects or APIs can be packaged into a microservice application, exported as a JAR, or hosted directly on the platform. This enables deployment flexibility and integration with a microservice runtime.

Code Hook Example

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

These hooks allow additional business rule processing before and after the core API logic.

Original source link: https://www.toutiao.com/i6914469326074479108