Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The OpenAPI specification is a language-agnostic standard for documenting HTTP APIs. Data API builder supports OpenAPI by:
- Generating metadata for all REST-enabled entities defined in the runtime configuration
- Compiling that metadata into a valid OpenAPI schema
- Exposing the schema through a visual UI (Swagger) or as a serialized JSON file
OpenAPI description document
Data API builder generates an OpenAPI description document using the runtime configuration and the database metadata for each REST-enabled entity.
The schema is built using the OpenAPI.NET SDK and conforms to the OpenAPI Specification v3.0.1. It is output as a JSON document.
You can access the OpenAPI document at:
GET /{rest-path}/openapi
[!NOTE] By default, the
rest-pathisapi. This value is configurable. See REST configuration for details.
Swagger UI
Swagger UI provides an interactive, web-based view of the API based on the OpenAPI schema.
In Development mode, Data API builder exposes Swagger UI at:
GET /swagger
This endpoint is not nested under the rest-path to avoid conflicts with user-defined entities.