API リソースの概要

このページは ApigeeApigee ハイブリッドに適用されます。

API を API Hub に登録する際は、API を表すエンティティを作成して保存します。このエンティティを API リソースと呼びます。API Hub に保存されている API リソースは検索可能で、API に関する詳細なオペレーション情報と説明情報を提供します。

API リソースは複雑なエンティティであり、1 つ以上のバージョンを関連付けることが可能です。バージョンは、ある時点での API の状態と考えることができます。各バージョンには、図 1 に示すように、API 仕様から解析されたオペレーションデプロイメントAPI 仕様など、独自のエンティティ セットを設定できます。

API エンティティの関係。

図 11 つの API に複数のバージョンを作成することもできます。

API を登録する際、または登録後に、API リソース属性を追加して編集し、API の詳細な説明を作成できます。詳しくは、属性を管理するをご覧ください。

API Hub は、システム定義属性とユーザー定義属性の両方をサポートしています。システム定義の属性の例:

  • API スタイル: デフォルト値が REST、gRPC、SOAP、Async API の属性。
  • ターゲット ユーザー: API の対象ユーザー(コンシューマー)
  • チーム: API を担当する制作チーム
  • ビジネス ユニット: API を担当するビジネス ユニット
  • 成熟度: API のライフサイクル ステージの指標

最後に、API リソースにはユーザー定義の属性を設定できます。これは、組織またはチームのニーズに基づいて設定で定義します。