发布于: Dec 1, 2016
现在，您可以向使用 Amazon API Gateway 构建的 API 的方法和资源中添加文档，以便您的 API 用户能够轻松了解您的 API。您可以使用 API Gateway 控制台、CLI 和开发工具包直接为 API 添加文档，或者只需使用 API 的 Swagger 定义中的文档标签来指定它。您还可以在 API 的常见方面重用文档。例如，您可以只编写一次标准错误文档，并在多个 API 响应中使用它，而无需复制实际内容，从而更快地为您的 API 创建文档并消除可能出现的“复制粘贴”错误。将文档作为 API 阶段的一部分发布后，可以使用 Swagger 导出功能将其导出，并使其在开发者门户中可用。
API Gateway 为您提供 API 定义和 API 文档创建的独立工作流程。这使 API 开发者和技术文档工程师能够并行工作，并使用控制台、CLI 和开发工具包分别导入其 Swagger。
有关更多信息，请参阅为 API Gateway API 创建文档。