API 仕様の概要

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

API 仕様について

API 仕様には、標準的な形式を使用して API が記述されています。機械判読可能でありながら、人間も簡単に読んで理解できます。仕様には通常、ベースパス、パスと動詞、ヘッダー、クエリ パラメータ、オペレーション、コンテンツ タイプ、レスポンス記述などの API 要素が記述されています（図 1 を参照）。

API バージョンには、OpenAPI 仕様、Proto、WSDL など、同じタイプまたは異なるタイプの API 仕様を複数含めることができます。サポートされている場合、API Hub で API 仕様を解析し、API ID、バージョン ID、記述、オペレーションなどの API メタデータを抽出して保存できます。仕様の解析をご覧ください。

API Hub での API 仕様の利用

API Hub では、API 仕様を使うかどうかにかかわらず API バージョンを作成できます。

バージョンの作成時に仕様をアップロードできます。ユーザー インターフェースで API の詳細を表示すると、API リソースのバージョンに関連付けられている仕様のリストが表示されます。

REST API で仕様を使用してバージョンを作成し、構成することもできます。API を利用する場合は、仕様を使って API バージョン エンティティを作成してから、そのバージョンを API リソースに関連付けます。

詳細については、バージョンに仕様を追加するをご覧ください。

仕様の解析

サポートされている場合、API Hub で API 仕様を解析して API に関する情報を抽出し、API バージョンを付けて保存できます。たとえば、API Hub で API OpenAPI 仕様を解析し、API ID、バージョン ID、記述、オペレーション、その他のメタデータを抽出して保存できます。

API Hub は、仕様の検証もサポートしています。API 仕様を検証するをご覧ください。