Hub OpenAPI 仕様 (OAS)
Swagger を使用して、Hub REST API の OpenAPI 仕様（OAS）ドキュメントを生成および公開しています。この豊富なアノテーションが付けられた OAS 3.0 定義は、JSON 形式で生成されます。このアーティファクトは、インタラクティブ API コンソールにフィードするように設計されており、Hub と統合する外部アプリケーションを開発するためのクライアントライブラリを構築するために使用されます。
OAS 3.0 の定義は、Swagger(英語)、API ジェネレーターを開く(英語)、Postman(英語) などのツールと互換性があります。これらのツールを使用すると、API をさまざまな方法で操作できます。
API がさまざまなパラメーターとオプションにどのように応答するかを理解するのに役立つサンドボックス UI で API を操作します。
コードベースで使用する前に、各リソースを表示してテストします。
推奨するプログラミング言語でクライアントライブラリを生成します。
OpenAPI 仕様へのアクセス
OAS 3.0 の定義は、次の Web アドレスに公開されています。
<Hub Service URL> は、ネットワーク環境での Hub サービスのベース URL です。
例: あなたの会社には、アドレス www.mycompany.com の独自ドメインがあります。www.mycompany.com/hub や hub.mycompany.com などのアドレスからアクセスできるように Hub を構成できます。
いずれの場合も、OpenAPI 仕様にアクセスするために必要なのは、Hub サービスのベース URL として設定されているアドレスに /api/rest/openapi.json を追加することだけです。
