Sdílet prostřednictvím

Dokumentace k rozhraní REST API pro tvůrce dat s využitím Swaggeru nebo OpenAPI

  • Článek

Specifikace OpenAPI je programovací standard pro dokumentaci rozhraní API HTTP nezávislá na programovacím jazyce. Tvůrce rozhraní Data API podporuje standard OpenAPI s jeho schopností:

  • Generovat informace o všech entitách definovaných konfigurací modulu runtime, které mají povoleno rozhraní REST.
  • Zkompilujte informace do formátu, který odpovídá schématu OpenAPI.
  • Zveřejňuje vygenerované schéma OpenAPI prostřednictvím vizuálního uživatelského rozhraní (Swagger) nebo serializovaného souboru.

Dokument s popisem OpenAPI

Tvůrce rozhraní Data API vygeneruje dokument s popisem OpenAPI pomocí zadané konfigurace modulu runtime a metadat databázových objektů pro každou definovanou entitu s povoleným rozhraním REST. Soubor schématu se generuje pomocí funkcí poskytovaných sadou OPENAPI.NET SDK. V současné době se soubor schématu generuje podle specifikace OpenAPI v3.0.1 formátované jako JSON.

Dokument s popisem OpenAPI je možné načíst z tvůrce rozhraní Data API z cesty:

GET /{rest-path}/openapi

Poznámka

Ve výchozím nastavení rest-path je api hodnota a je konfigurovatelná. Další informace najdete v tématu Konfigurace REST.

SwaggerUI

Swagger UI nabízí webové uživatelské rozhraní, které poskytuje informace o službě pomocí vygenerované specifikace OpenAPI.

Tvůrce Development rozhraní Data API v režimu umožňuje zobrazit vygenerovaný dokument s popisem OpenAPI z vyhrazeného koncového bodu:

GET /swagger

Koncový bod Swagger není vnořený pod rest-path , aby nedocházelo ke konfliktům názvů s entitami nakonfigurovanými za běhu.

Související obsah