APIライブラリ ​

APIライブラリは、組織内の他のユーザーが検出できるAPIコレクションの一元化されたカタログです。 ここでは、ユーザーがAPIを正常に導入するために必要なドキュメント、例、ツールを見つけることができます。

ライブラリには、次の主要機能が含まれています:

• 自動ドキュメント: すべてのAPIコレクションに対してOpenAPI仕様が自動的に生成されます。 ユーザーは、好みのツールでこれを参照して使用できます。
• Swaggerテストツール: ライブラリ内のAPIコレクションはSwagger UIで表示されます。Swagger UIにはサンプルのリクエストデータとレスポンスデータが表示され、ユーザーはエンドポイントに対してテスト呼び出しを実行できます。
• ワークスペースベースの共有: ロールベースのアクセス設定を使用して、ワークスペース内のユーザーとAPIを安全に共有できます。
• アクセス制御: ユーザーは共有APIコレクション内のエンドポイントを表示およびテストできます。実際のデータを使用するには、ユーザーはAPI発行者に権限をリクエストし、取得する必要があります。

共有コレクションを含むAPIライブラリ

APIコレクションの共有 ​

APIコレクションは、デフォルトではライブラリで利用できません。 コレクションを共有するには、APIコレクション＞設定＞共有に移動し、APIライブラリに表示をクリックします。 APIコレクションの共有タブ

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

API platformへのアクセス権を持つユーザーは、ライブラリ内の共有コレクションを参照できます。 各コレクションページには、OpenAPI仕様ファイル、ユーザーがサンプルのリクエストデータとレスポンスデータを確認し、エンドポイントをテストできるSwagger UIが含まれています。

APIを使用するには、右上隅のアクセスをリクエストをクリックし、必要に応じて理由を入力します。 リクエストはメールとしてAPI発行者に送信されます。