OpenAPI in Data API Builder

De OpenAPI-specificatie is een taalagnostische standaard voor het documenteren van HTTP-API's. Data API Builder ondersteunt OpenAPI door:

• Metagegevens genereren voor alle REST-entiteiten die zijn gedefinieerd in de runtimeconfiguratie
• Deze metagegevens compileren in een geldig OpenAPI-schema
• Het schema weergeven via een visuele ui (Swagger) of als een geserialiseerd JSON-bestand

OpenAPI-beschrijvingsdocument

Data API Builder genereert een OpenAPI-beschrijvingsdocument met behulp van de runtimeconfiguratie en de databasemetagegevens voor elke entiteit met REST-functionaliteit.

Het schema wordt gebouwd met behulp van de OpenAPI.NET SDK en voldoet aan de OpenAPI-specificatie v3.0.1. Het wordt uitgevoerd als een JSON-document.

U kunt het OpenAPI-document openen op:

GET /{rest-path}/openapi

[! OPMERKING] De rest-path standaardwaarde is api. Deze waarde kan worden geconfigureerd. Zie DE REST-configuratie voor meer informatie.

Swagger UI

Swagger UI biedt een interactieve webweergave van de API op basis van het OpenAPI-schema.

In Development de modus maakt Data API Builder Swagger UI beschikbaar op:

GET /swagger

Dit eindpunt is niet genest onder de rest-path om conflicten met door de gebruiker gedefinieerde entiteiten te voorkomen.