API ライブラリ

API ライブラリは、組織内の他ユーザーが検出できる API コレクションの一元的なカタログです。ユーザーは API を適切に導入するのに必要なドキュメント、サンプル、ツールをそこで見つけることができます。

ライブラリの主な機能は以下の通りです。

• 自動化されたドキュメント作成 : API コレクションすべてに対して、OpenAPI 仕様書が自動的に生成されます。ユーザーは、その仕様書を閲覧したり、好みのツールで利用したりできます。
• Swagger テストツール : ライブラリ内の API コレクションは、Swagger UI で表示されます。ユーザーは Swagger UI でリクエストデータやレスポンスデータのサンプルを確認し、エンドポイントに対するテスト呼び出しを実行できます。
• ワークスペースベースの共有 : ロールベースのアクセス設定を利用して、API をワークスペース内のユーザーと安全に共有できます。
• アクセス制御 : ユーザーは共有された API コレクション内のエンドポイントを表示したりテストしたりできます。実際のデータを使用するには、ユーザーはアクセス許可を API パブリッシャに要求し、受け取る必要があります。

API ライブラリと共有のコレクション

API コレクションの共有

デフォルトでは、API コレクションはライブラリ内で利用可能となっていません。コレクションを共有するには、 [API collection] > [Settings] > [Sharing] に移動して、 [Show in API library] をクリックします。 API コレクション共有タブ

ライブラリ内の API へのアクセス権の取得

API プラットフォームにアクセスできるユーザーは、ライブラリ内の共有コレクションを閲覧できます。それぞれのコレクションのページには、OpenAPI 仕様書ファイルが含まれています。これは Swagger UI であり、ユーザーはそこでリクエストデータやレスポンスデータのサンプルを確認したり、エンドポイントをテストしたりできます。 API ライブラリ - コレクションページ

API を利用するには、右上隅の [Request access] をクリックし、必要に応じて理由を記入します。リクエストは、電子メールで API パブリッシャに送信されます。 API ライブラリ - アクセス権のリクエスト