メインコンテンツまでスキップ

API Document

API Document

  • APIドキュメントのリストを表示します。
  • Swaggerドキュメントがメニュー > API管理 > API詳細画面を通じて入力され、デプロイされた場合、最も最近デプロイされたバージョンのSwaggerドキュメントが表示されます。

  • APIドキュメントの詳細画面には、以下の画像に示すようにSwagger UIが表示されます。
  • Swagger UIの[Authorize]ボタンを使用してAPI KEYを設定し、APIテストを実行できます。(詳細についてはAPI KEYの作成/管理を参照してください)
  • Swaggerドキュメント内の各特定のAPIに対して、[Try it out] > [Execute]ボタンをクリックすることでAPIテストを実行できます。