Developer Guide / API & Swagger

API & Swagger

Explore and test service APIs.

Every backend service publishes OpenAPI (OAS 3.0) documentation. The admin console bundles an API Documentation screen — an interactive Swagger UI for each microservice — with a service selector that shows each service's status and base path (for example /api/docs/assets).

Reaching the API docs

Open API Documentation from the app (also available under Infrastructure → API Docs), pick a service, and browse or try its endpoints. Each service also exposes its Swagger UI through the gateway.

/api/<service>/swagger-ui.html        # per-service Swagger UI via the gateway
/api/docs/<service>                   # OpenAPI definition used by the in-app viewer
The in-app API Documentation (Swagger UI) with service selector.
The in-app API Documentation (Swagger UI) with service selector.
i
Because the gateway validates JWTs, calls you make from Swagger must carry a valid token for protected endpoints.