Skip to content

API Generation

API generation reads a compiled manifest and produces REST API endpoints. Each entity in the manifest drives a set of CRUD routes.

Current implementation

text
@ikary/cell-runtime-api (app)

The API runtime currently ships as an app in this monorepo. A standalone generation package is not published yet.

What it generates

Given an entity in the manifest, the generator produces five endpoints per resource:

MethodPathAction
GET/resourceList with filtering and pagination
GET/resource/:idFetch a single record
POST/resourceCreate a record
PATCH/resource/:idUpdate a record
DELETE/resource/:idDelete a record

Role scopes from the manifest apply to each endpoint. A role with actions: [read] on an entity gets access to the GET endpoints only.

Routes follow the API Conventions.

Run from the monorepo

bash
pnpm --filter @ikary/cell-runtime-api dev

This starts the runtime API service for local development.