Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

在 API Gateway 中记录 REST API

为帮助客户了解和使用您的 API,您应记录 API。为帮助您记录 API,API Gateway 支持您为各个 API 实体添加和更新帮助内容,这是 API 开发流程中不可或缺的一部分。API Gateway 将存储源内容,并使您能够存档不同版本的文档。您可以将一个文档版本与一个 API 阶段关联,将特定于阶段的文档快照导出为外部 OpenAPI 文件,并将该文件以文档发布的形式分发。

要记录 API,您可以调用 API Gateway REST API,使用一个 AWS 软件开发工具包 或针对 API Gateway 的 AWS CLI,或者使用 API Gateway 控制台。此外,您还可以导入或导出在外部 OpenAPI 文件中定义的文档部分。在介绍如何记录 API 之前,我们将展示 API 文档在 API Gateway 中的表示形式。