如何使用Swagger UI访问AWS API Gateway文档

时间:2019-01-15 20:42:33

标签: amazon-web-services aws-sdk aws-api-gateway

我已经使用AWS Api Gateway创建了API。然后,我为所有实体(如API,资源,方法,模型等)记录了文档部分。然后,我使用AWS Gateway Console将文档发布到dev阶段,版本为1

但是我不确定我(或API的使用者)将如何访问文档?

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

我想知道,发布文档后,无论如何,消费者都可以直接通过http访问文档。因此,假设我的dev阶段api URL是 https://devapi.example.com/v1,因此类似https://devapi.example.com/v1/help之类的应该使用最新发布的swagger文件启动Swagger UI

更新1
在ASP.NET Web API或.NET Core中,您可以包括创建Swashbuckle的{​​{1}},该文件还可以创建swagger文件,并且还具有Swagger UI工具的嵌入式版本。因此,在部署API之后,用户可以直接从用户界面访问https://devapi.example.com/swagger之类的文档。
我希望AWS网关也能提供同样的服务。发布文档后,应通过一些预定义的资源路径使该文档可用。

2 个答案:

答案 0 :(得分:0)

AWS API网关只能使文档可导出,而不能呈现UI应用程序。网关中没有可用于呈现文档的终结点。您可能希望使用第三方工具或AWS API Gateway Developer Portal来允许用户浏览API文档。您可能会发现此blog有用。

答案 1 :(得分:0)

您可以尝试https://www.npmjs.com/package/micro-swagger

npm i -g micro-swagger
micro-swagger start