Browse knowledge base
InitialFirst draft, may evolve based on feedback

API Design

Treat application APIs as explicit contracts

Treat application APIs as explicit contracts

Define public API versions, exposed tables/fields, authentication, filtering, paging, and response models through the application API metadata. Middleware used by the admin interface is a separate API surface.

Inspect the generated OpenAPI specification from the running application and test clients against it. Do not assume a generic /api/v1/table route or uniform response envelope. See API reference.

Was this helpful?

Help us improve this article. Feedback is used to prioritize content updates.

Powered by qqq