REST API Reference (Swagger UI)

The interactive Swagger UI below is generated from the live cnuas-api OpenAPI schema, so it always matches the shipped service. Use it to browse every endpoint, expand request and response schemas, and read parameter details.

Try it against a running service

The Try it out buttons issue real requests. Point them at a running Cnuas API by starting the service (cnuas api --host 0.0.0.0 --port 8080) and setting the server URL at the top of the panel. When browsing these docs statically, use it as a schema reference.

Prefer a three-pane reading layout? See the ReDoc reference. The raw schema is available at openapi.json.