OpenAPI 仕様は、HTTP API を文書化するための言語に依存しない標準です。 データ API ビルダーは、次の方法で OpenAPI をサポートします。
- ランタイム構成で定義されているすべての REST 対応エンティティのメタデータの生成
- そのメタデータを有効な OpenAPI スキーマにコンパイルする
- ビジュアル UI (Swagger) を介して、またはシリアル化された JSON ファイルとしてスキーマを公開する
OpenAPI の説明ドキュメント
データ API ビルダーは、ランタイム構成と各 REST 対応エンティティのデータベース メタデータを使用して、OpenAPI 記述ドキュメントを生成します。
スキーマは 、OpenAPI.NET SDK を使用して構築され、 OpenAPI 仕様 v3.0.1 に準拠しています。 JSON ドキュメントとして出力されます。
OpenAPI ドキュメントには、次の場合にアクセスできます。
GET /{rest-path}/openapi
[!注] 既定では、
rest-pathはapi。 この値は構成可能です。 詳細については、 REST 構成 を参照してください。
Swagger UI
Swagger UI は、OpenAPI スキーマに基づく API の対話型の Web ベースのビューを提供します。
Development モードでは、データ API ビルダーは次の場合に Swagger UI を公開します。
GET /swagger
このエンドポイントは、ユーザー定義エンティティとの競合を回避するために、rest-path の下にネストされていません。