How Object‑Model‑Driven API Platforms Streamline Full Lifecycle Management

API Full Lifecycle Management

The API gateway should focus on runtime concerns and remain lightweight, leaving protocol conversion, adaptation, and data mapping to an API rapid‑development platform that registers standard HTTP APIs with the gateway.

Object‑Model‑Driven Development

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

Core ideas include object modeling that decouples interfaces from underlying databases, enabling multi‑database and multi‑table support. Defined objects automatically generate standard CRUD endpoints (POST, GET, DELETE, etc.) and contract files such as RAML, YAML, or WADL, similar to Swagger.

Common API Operations

Typical generated operations include create, update by primary key, query, delete, and conditional queries. Open‑source tools like npm install -g xmysql can expose an entire MySQL schema as REST APIs for testing, though they lack built‑in permission control.

Composite Object Generation

Composite objects (e.g., an order with header and line items) can be generated in a single API call, supporting transactional consistency and returning a combined JSON representation.

Pagination Support

Generated query APIs should support pagination parameters such as page size and page number.

Custom API Definition and Publishing

Beyond object‑driven APIs, the platform allows custom method‑based APIs, binding them to JAR methods, dynamic SQL, or stored procedures, with input/output mapping and schema adaptation.

Rule Processing

Simple rule handling includes input validation, data‑item mapping, custom scripting, and message‑header/response‑field conventions for security tokens, routing, and error codes.

Service Composition & Orchestration

The platform supports service composition (parallel or sequential), service trimming/enrichment, and workflow‑style orchestration where outputs of one service become inputs of another, enabling complex business scenarios such as contract import with validation steps.

Source Code Export

For complex business logic, developers can export compilable source code with extension points, e.g.,

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

Microservice Application

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

Author: Ruo Fei