OpenAPI v Tvůrci rozhraní Data API

Specifikace OpenAPI je jazykově nezávislý standard pro dokumentaci rozhraní HTTP API. Tvůrce rozhraní Data API podporuje OpenAPI podle:

• Generování metadat pro všechny entity s podporou REST definované v konfiguraci modulu runtime
• Kompilace metadat do platného schématu OpenAPI
• Zveřejnění schématu prostřednictvím vizuálního uživatelského rozhraní (Swagger) nebo jako serializovaný soubor JSON

Dokument popisu OpenAPI

Tvůrce rozhraní Data API generuje dokument s popisem OpenAPI pomocí konfigurace modulu runtime a metadat databáze pro každou entitu s podporou REST.

Schéma se sestaví pomocí sady OpenAPI.NET SDK a odpovídá specifikaci OpenAPI v3.0.1. Výstupem je dokument JSON.

K dokumentu OpenAPI se dostanete na adrese:

GET /{rest-path}/openapi

[!POZNÁMKA] Ve výchozím nastavení je rest-pathapi. Tato hodnota je konfigurovatelná. Podrobnosti najdete v konfiguraci REST .

Swagger UI

Swagger UI poskytuje interaktivní webové zobrazení rozhraní API založené na schématu OpenAPI.

Tvůrce Development rozhraní Data API v režimu zveřejňuje uživatelské rozhraní Swagger na adrese:

GET /swagger

Tento koncový bod není vnořený pod rest-path, aby se předešlo konfliktům s entitami definovanými uživatelem.