API 规范简介

本页面适用于 Apigee 和 Apigee Hybrid。

API 规范使用标准格式来描述 API。它们是机器可读的，但也便于人类阅读和理解。规范通常描述 API 的元素，例如基本路径、路径和动词、标头、查询参数、操作、内容类型、响应说明等，如图 1 所示。

API 版本可以包含相同或不同类型的多个 API 规范，例如 OpenAPI 规范、Proto 和 WSDL。如果支持，API Hub 可以解析 API 规范来提取和存储 API 元数据，例如 API ID、版本 ID、说明和操作。请参阅规范解析。

将 API 规范与 API Hub 搭配使用

您可以在 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 规范。

如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可，并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。

最后更新时间 (UTC)：2025-03-05。