API 规范简介

本页面适用于 ApigeeApigee Hybrid

API 规范简介

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

API 资源可以包含相同或不同类型的多个 API 规范,例如 OpenAPIgRPCRAML 等。在支持的情况下,API Hub 可以解析 API 规范以提取和存储 API 元数据,例如 API ID、版本 ID、说明和操作。请参阅规范解析

将 API 规范与 API Hub 搭配使用

您可以在具有或没有 API 规范的 API Hub 中创建 API 资源。

如果 API 具有 API 规范,您可以在创建 API 资源时上传该规范。规范将与 API 资源的初始版本相关联。在界面中查看 API 的详细信息时,您将看到与该 API 资源关联的所有规范的列表。

您还可以使用 REST API 通过规范来创建和配置 API 资源。使用 API 时,您可以使用该规范创建 API 版本实体,然后将版本附加到 API 资源。

如需了解详情,请参阅向版本添加 API 规范

规范解析

在支持的情况下,API Hub 可以解析 API 规范以提取有关 API 的信息并使用 API 版本存储它。例如,API Hub 可以解析 API OpenAPI 规范以提取和存储 API ID、版本 ID、说明、操作和其他元数据。