OpenAPI 仕様に基づいて、API Server のAPI は完全にドキュメント化され検出可能です。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 定義

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

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

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