Version 25.3.9411

• サービスドキュメント
• メタデータURL
• OpenAPI 定義

API Server のAPI はOpenAPI 仕様に基づいており、完全にドキュメント化され検出可能です。API には、標準のJavaScript、OpenAPI 準拠のアプリケーション、またはOData 標準をサポートするアプリケーションからアクセスできます。次のセクションでは、これらのスタンダードを使用してAPI を検出する方法について説明します。

サービスドキュメント

サービスドキュメントは、デフォルトではJSON 形式のすべてのAPI の単純なリストです。サービスドキュメントは、メタデータ検出リクエストを含むすべてのリクエストが生成されるサービスルートから返されます。次にサービスルートの例を示します：

http://MyServer:MyPort/api.rsc/

より詳細な情報を取得するには、メタデータURL にリクエストを送信します。

メタデータURL

API Server はOData コンシューマーに、OData メタデータドキュメントURL を通じてAPI 機能を公開します。メタデータドキュメントは、XML で返され、カラムのデータ型、テーブルキーカラム、および他の情報を含みます。次の例に示すように、$metadata をサービスルートに追加することで、完全なメタデータテーブルリソースにアクセスすることができます：

http://MyServer:MyPort/api.rsc/$metadata

テーブルのメタデータにアクセスするには、次の例に示すようにテーブルURL に$metadata を追加します：

http://MyServer:MyPort/api.rsc/Cars/$metadata

OpenAPI 定義

OpenAPI（Swagger）定義は、API Server を通じて公開するデータソースに対して生成されます。

Swagger 定義を取得するには、次の例に示すようにサービスルートに$swagger を追加します：

http://MyServer:MyPort/api.rsc/$swagger