针对 API Gateway 中的 REST API 的文档

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

要记录您的 API，您可以调用 API Gateway REST API，使用其中一个 AWS SDK，使用适用于 API Gateway 的 AWS CLI，或者使用 API Gateway 控制台。此外，您还可以导入或导出在外部 OpenAPI 文件中定义的文档部分。

要与开发人员共享 API 文档，您可以使用开发人员门户。有关示例，请参阅 AWS 合作伙伴网络 (APN) 博客上的将 ReadMe 与 API Gateway 集成，让开发人员中心保持最新状态或如何使用 SmartBear 的 SwaggerHub 简化 Amazon API Gateway 上的 API 开发。