如何使用 Middy 与招摇

Posted 2023-03-28

【中文标题】如何使用 Middy 与招摇

【英文标题】：How to use Middy with swagger

【发布时间】：2021-12-14 09:58:24

【问题描述】：

我对使用 Middy 框架很陌生，我想知道我们如何自动生成 Swagger 文档。

另一种解决方法是创建一个 swagger 文件，在其中我使用代码生成 swagger 文档，然后提供一个 lambda 函数来显示我们的 swagger-UI 页面。

如果有人也可以向我指出任何资源，我将不胜感激。

【问题讨论】：

请编辑问题以将其限制为具有足够详细信息的特定问题，以确定适当的答案。

【参考方案1】：

middy 与路由、输入和输出结构无关。

如果您使用@middy/validator，您可以获取 JSON Schema 文件并将它们转换为 OpenAPI，即 Swagger，swagger-UI 可以摄取的 json 文件。为保持流程简单，建议使用规范的 v3.1，因为它与 JSON Schema 版本 2019-09 100% 兼容。