Published APIs

Prev Next

Classic/VPC環境で利用できます。

Productの APIドキュメントを共有したり、他のユーザーが共有した APIドキュメントをサブスクリプションできます。

参考

作成した Productの APIドキュメントを掲示、確認および管理する方法は My Productsメニューの Catalog確認をご参照ください。

Published APIs画面とリスト

API Gatewayを利用するための Published APIsメニューの基本的な説明は、次の通りです。

apigw-publishedapis-list_ko

領域 説明
① メニュー名 現在確認中のメニュー名、サブスクリプションできる Product数
② 基本機能 API Gateway詳細情報の確認、ページの更新
③ Catalog ユーザーと他のユーザーが共有した APIドキュメントの確認とサブスクリプション
④ 検索ボックス Product名を入力した後、i-apigateway-findをクリックして項目検索
⑤ フィルタ API提供位置(デフォルト値: NCP)、サブスクリプション有無を基準に項目をフィルタリング
  • NAVERクラウドプラットフォームで提供する API以外に他の APIリストを照会するにはフィルター変更
  • ユーザーが掲示した APIを検索するには Myを選択
⑥ ソート リストのページごとに表示する API数の設定
⑦ リスト ユーザーと他のユーザーが共有した APIリスト
  • Product名: 掲載された Productの名前
  • 説明: 掲載された Productに関する説明
  • サブスクリプション方式: 掲載された Productのサブスクリプション方式(公開、保護)
  • サブスクリプション: 掲載された Productに対するユーザーのサブスクリプション有無

Catalogを見る

Productに作成された APIの Overviewを確認して、Stageの Documentを Swagger UIで確認できます。
ユーザーが掲載した APIの場合、Overview内容を変更できます。

掲載された APIの Overviewと Documentを確認する方法は以下の通りです。

  1. NAVERクラウドプラットフォームコンソールでi_menu > Services > Application Services > API Gatewayメニューを順にクリックします。
  2. Published APIsメニューをクリックします。
  3. 掲載された Productリストで情報を確認する Productをクリックして選択し、 [Catalog] ボタンをクリックします。
    • NAVERクラウドプラットフォームで提供する API以外の他の APIリストを照会するには、フィルターの Product項目を変更します。
  4. Productの Catalogリストで確認する API名をクリックします。
  5. 照会詳細画面で APIの Overviewと Stageの Documentを確認します。
    • ユーザーが直接作成した APIの場合、Overview内容を変更できる [変更] ボタンが表示されます。変更するには [変更] ボタンをクリックして内容を作成し、 [保存] ボタンをクリックします。Overview作成についての詳細は、 API説明書の Overview作成をご参照ください。
    • Stageの Document内容を Swagger UIで確認するには Stage名または i-apigateway-viewをクリックします。

Catalogサブスクリプションの申し込み

掲載された Productのサブスクリプション方式は公開と保護があります。

  • 公開: 承認の手続きなしに誰でも Productの APIを呼び出すことができ、当該 Catalogリスト画面に [サブスクリプション] ボタンが表示されない
  • 保護: Productの APIを使用するためには掲載者の承認が必要であり、当該 Catalogリスト画面に [サブスクリプション] ボタンが表示される

掲載された Productのサブスクリプション方式が保護の場合、サブスクリプションするには API Keyを作成し、API Keyの承認手続きをする必要があります。

Catalogサブスクリプションを申し込む方法は以下の通りです。

  1. NAVERクラウドプラットフォームコンソールでi_menu > Services > Application Services > API Gatewayメニューを順にクリックします。
  2. Published APIsメニューをクリックします。
  3. Published APIsメニューでサブスクリプションタイプが保護の Productをクリックして選択し、 [Catalog] ボタンをクリックします。
  4. Productの Catalogリストで [サブスクリプション] ボタンをクリックします。
  5. サブスクリプションを申し込む APIに対して認証を受ける API Keyを選択し、 [サブスクリプションリクエスト] ボタンをクリックします。
  6. サブスクリプションのポップアップで [サブスクリプションリクエスト] ボタンをクリックします。