OpenAPI a Data API Builderben

Az OpenAPI-specifikáció egy nyelvfüggetlen szabvány a HTTP API-k dokumentálására. A Data API Builder a következővel támogatja az OpenAPI-t:

• Metaadatok létrehozása a futtatókörnyezet konfigurációjában definiált összes REST-kompatibilis entitáshoz
• Metaadatok összeállítása érvényes OpenAPI-sémába
• A séma megjelenítése vizuális felhasználói felületen (Swagger) vagy szerializált JSON-fájlként

OpenAPI leírási dokumentum

A Data API Builder egy OpenAPI-leíró dokumentumot hoz létre az egyes REST-kompatibilis entitások futtatókörnyezeti konfigurációjának és adatbázis-metaadatainak használatával.

A séma a OpenAPI.NET SDK használatával készült, és megfelel az OpenAPI 3.0.1-s specifikációjának. JSON-dokumentumként kimenet.

Az OpenAPI-dokumentum a következő címen érhető el:

GET /{rest-path}/openapi

[! MEGJEGYZÉS] Alapértelmezés szerint a rest-path alapértelmezett api. Ez az érték konfigurálható. Részletekért lásd a REST-konfigurációt .

Swagger felhasználói felület

A Swagger felhasználói felülete interaktív, webes nézetet biztosít az API-ról az OpenAPI-séma alapján.

Módban Development a Data API Builder a következő helyen teszi elérhetővé a Swagger felhasználói felületét:

GET /swagger

Ez a végpont nincs beágyazva a rest-path felhasználó által definiált entitásokkal való ütközések elkerülése érdekében.