amazon-web-services - 如何使用 Swagger UI 访问 AWS API Gateway 文档

Question

我已经使用 AWS Api Gateway 创建了 API。然后我记录了所有实体的文档部分(如 API、资源、方法、模型等)。然后使用 AWS 网关控制台，我已将文档发布到 dev舞台版本1
但我不确定我(或 API 的使用者)如何访问文档？

有一个Export可以将文档导出为 Swagger 的选项或 OpenAPI3 .这将创建 .json或 .yaml文件，然后消费者必须将这些文件导入 swagger UI。然而，这不是用户友好的选项，每次我向所有消费者更新文档时都提供 swagger 文件。

我想知道，在发布文档之后，消费者是否可以直接通过 http 访问文档。所以让我们假设我的 dev阶段 api URL 是https://devapi.example.com/v1所以像 https://devapi.example.com/v1/help应该推出 Swagger UI带有最新发布的 swagger 文件。

更新 1
在 ASP.NET Web API 或 .NET Core 中，您可以包含 Swashbuckle创建 swagger 文件并且还具有 Swagger UI 工具的嵌入式版本。因此，在部署 API 后，用户可以直接从 UI 访问文档，例如 https://devapi.example.com/swagger .
我希望 AWS 网关也能做到同样的事情。发布文档后，它应该通过一些预定义的资源路径使该文档可用。

Answer 1

AWS API Gateway 只能使文档可导出，但不会呈现 UI 应用程序。网关中没有可用于呈现文档的端点。您可能希望使用第三方工具或 AWS API Gateway Developer Portal允许用户浏览 API 文档。你可能会发现这个 blog有帮助。