Rest API-documentatie voor Data API Builder met Swagger/OpenAPI
De OpenAPI-specificatie is een programmeertaal-agnostische standaard voor het documenteren van HTTP-API's. Data API Builder ondersteunt de OpenAPI-standaard met de mogelijkheid om:
- Genereer informatie over alle door runtimeconfiguratie gedefinieerde entiteiten waarvoor REST is ingeschakeld.
- Compileer de informatie in een indeling die overeenkomt met het OpenAPI-schema.
- Maakt het gegenereerde OpenAPI-schema beschikbaar via een visuele gebruikersinterface (Swagger) of een geserialiseerd bestand.
OpenAPI-beschrijvingsdocument
Data API Builder genereert een OpenAPI-beschrijvingsdocument met behulp van de opgegeven runtimeconfiguratie en de metagegevens van het databaseobject voor elke gedefinieerde ENTITEIT met REST. Het schemabestand wordt gegenereerd met behulp van de functionaliteit van de OpenAPI.NET SDK. Op dit moment wordt het schemabestand gegenereerd in overeenstemming met OpenAPI-specificatie v3.0.1 , opgemaakt als JSON.
Het OpenAPI-beschrijvingsdocument kan worden opgehaald uit data-API builder via het pad:
GET /{rest-path}/openapi
Notitie
De waarde is en kan standaard rest-path worden api geconfigureerd. Zie REST-configuratie voor meer informatie
SwaggerUI
Swagger UI biedt een webinterface die informatie over de service biedt, met behulp van de gegenereerde OpenAPI-specificatie.
In Development de modus maakt Data API Builder het mogelijk om het gegenereerde OpenAPI-beschrijvingsdocument weer te geven vanaf een toegewezen eindpunt:
GET /swagger
Het eindpunt 'Swagger' is niet genest onder de rest-path om naamconflicten met door runtime geconfigureerde entiteiten te voorkomen.