Swagger/OpenAPI を使用したデータ API ビルダー REST API のドキュメント
OpenAPI 仕様は、HTTP API を文書化するためのプログラミング言語に依存しない標準です。 データ API ビルダーでは、次の機能を備えた OpenAPI 標準がサポートされています。
- REST が有効になっているすべてのランタイム構成定義エンティティに関する情報を生成します。
- OpenAPI スキーマに一致する形式に情報をコンパイルします。
- 生成された OpenAPI スキーマを、ビジュアル UI (Swagger) またはシリアル化されたファイルを介して公開します。
OpenAPI の説明ドキュメント
データ API ビルダーは、指定されたランタイム構成と、定義された各 REST 対応エンティティのデータベース オブジェクト メタデータを使用して、OpenAPI 記述ドキュメントを生成します。 スキーマ ファイルは、 OpenAPI.NET SDK によって提供される機能を使用して生成されます。 現在、スキーマ ファイルは、JSON 形式の OpenAPI Specification v3.0.1 に準拠して生成されます。
OpenAPI 記述ドキュメントは、パスから Data API ビルダーからフェッチできます。
GET /{rest-path}/openapi
注意
既定では、 rest-path 値は であり api 、構成可能です。 詳細については、「REST の構成」を参照してください。
SwaggerUI
Swagger UI には、生成された OpenAPI の仕様を使用してサービスに関する情報が提供される Web ベースの UI が用意されています。
モードでは Development 、Data API ビルダーを使用すると、生成された OpenAPI 記述ドキュメントを専用エンドポイントから表示できます。
GET /swagger
"Swagger" エンドポイントは、ランタイムで構成されたエンティティとの名前の競合を回避するために、 の下 rest-path に入れ子になりません。