Rest API-dokumentation för data-API:et med Swagger/OpenAPI
OpenAPI-specifikationen är en programmeringsspråkagnostisk standard för att dokumentera HTTP-API:er. Data API Builder stöder OpenAPI-standarden med möjligheten att:
- Generera information om alla körningskonfigurationsdefinierade entiteter som är REST-aktiverade.
- Kompilera informationen till ett format som matchar OpenAPI-schemat.
- Exponerar det genererade OpenAPI-schemat via ett visuellt användargränssnitt (Swagger) eller en serialiserad fil.
OpenAPI-beskrivningsdokument
Data API Builder genererar ett OpenAPI-beskrivningsdokument med hjälp av den angivna körningskonfigurationen och databasobjektmetadata för varje definierad REST-aktiverad entitet. Schemafilen genereras med hjälp av funktioner som tillhandahålls av OpenAPI.NET SDK. För närvarande genereras schemafilen i enlighet med OpenAPI Specification v3.0.1 formaterad som JSON.
OpenAPI-beskrivningsdokumentet kan hämtas från Data API Builder från sökvägen:
GET /{rest-path}/openapi
Anteckning
Som standard är api värdet rest-path och kan konfigureras. Mer information finns i REST-konfiguration
SwaggerUI
Swagger UI erbjuder ett webbaserat användargränssnitt som tillhandahåller information om tjänsten med hjälp av den genererade OpenAPI-specifikationen.
I Development läge aktiverar Data API Builder det genererade OpenAPI-beskrivningsdokumentet från en dedikerad slutpunkt:
GET /swagger
Swagger-slutpunkten är inte kapslad under rest-path för att undvika namngivningskonflikter med körnings konfigurerade entiteter.