ディスカバーされた API の確認
API ディスカバリー 機能でディスカバーされた OpenAPI 文書を確認する方法。
開始前に
ディスカバーされた API を編集できるようにするには、以下のいずれかの役割が必要です。
- 組織管理者
- 所有者
- 以下のいずれかの権限を持つカスタム役割:
- 設定: 管理
- API ドラフト: 編集 (Api-Drafts: Edit)
このタスクについて
APIディスカバリーは IBM® API Connect のアドオンで、APIを発見し、API開発プロセスに追加するために使用できる。 ソースコレクタが API discovery 機能に追加されると、 API Manager で検出された OpenAPI ドキュメントを管理できます。
手順
ディスカバーされた OpenAPI 文書を管理するには、以下の手順を実行します。
- API Manager の UI で、 [Discover] アイコンをクリックし、 [APIs] タブが選択
されていることを確認してください。 - OpenAPI 文書のメタデータを表示するには、確認したい文書の横にある「 オプション
」アイコンをクリックし、「 メタデータを表示 」を選択します。API の簡単な説明が表示されます。 次に、 「API の表示」 をクリックして完全な OpenAPI 文書を表示するか、 「API の非表示」 をクリックしてリスト内の API を非表示にします。 - OpenAPI 文書をドラフト API にコピーするには、以下のいずれかの方法を使用できます。
- [API ] タブにある利用可能な OpenAPI ドキュメントの一覧から、コピーしたいドキュメントの横にある オプションアイコンをクリックし、[ 下書きにコピー ] を選択します。
- OpenAPI 文書内で、 「ドラフトにコピー」をクリックします。
その後、 API Manager UI の 「開発」 セクションの 「API」 タブをクリックすると、コピーした文書が API のリストに表示されます。 このAPIのライフサイクルは、 API Manager で編集および管理できるようになりました。詳細については、 「API開発チェックリスト 」および 「API定義の操作」 を参照してください。
- [API ] タブにある利用可能な OpenAPI ドキュメントの一覧から、コピーしたいドキュメントの横にある
- （オプション）： OpenAPI ドキュメントの横にある 「オプション」 アイコンをクリックすると、そのドキュメントをさらに詳細に管理できます。 使用可能なオプションは次のとおりです。
- ダウンロード -API をダウンロードします。
- メタデータの表示 -API の簡単な説明を表示します。
- 「ドラフトにコピー」 -文書をドラフト API にコピーします。
- API の非表示 -API のリストで文書を非表示にします。 「非表示のAPI」は、[ フィルター] アイコン
をクリックし、[ 表示 ] カテゴリから [非表示のAPI] を選択して、 [適用] をクリックすることで表示できます。 その後、再度表示する文書に対して 「API の表示」 オプションを選択できます。 API を表示するには、フィルターを変更して 「非表示の API」 チェック・ボックスをクリアする必要があります。 - API の削除 -API のリストから文書を削除します。 API がドラフトにコピーされている場合、API はディスカバーされた API のリストからのみ削除されます。ドラフト API のリストからは削除されません。 削除された API がソース内にまだ存在する場合は、その API を再度ディスカバーできます。 リストから API 文書を削除し、再度ディスカバーしない場合は、 「API の非表示」 オプションを選択できます。
- （任意）： テーブルのヘッダー
にある「 列の管理 」アイコンをクリックすると、列の順序や表示を変更できます。