如何在 swagger 编辑器中自动生成 api 文档的 yaml 代码？答案

【问题标题】：How to auto generate the yaml code for api documentation in swagger editor?如何在 swagger 编辑器中自动生成 api 文档的 yaml 代码？
【发布时间】：2020-06-12 10:21:23
【问题描述】：

我想使用 swagger 设计我的 web api，但问题是我必须自己编写所有 yaml 代码，这本身就是一个耗时且乏味的过程。这个过程可以自动化吗？

我尝试搜索但没有任何有用的东西。是否可以在创建 api 本身之前自动生成用于 api 设计的 yaml 代码。

如果 yaml 代码不能自动生成，那为什么要使用 swagger 进行 api 设计。

任何帮助将不胜感激。谢谢！

【问题讨论】：

是的很多，找到了这些类型的链接，他们解释了如何编写 yaml 而不是自动生成它。 idratherbewriting.com/learnapidoc/…
swagger.io/tools/open-source/open-source-integrations - 有针对不同编程语言的库可以从源代码注释生成 OpenAPI 定义。例如，Java 的 Springfox 或 Swagger Core； .NET 的 Swashbuckle 或 Swagger-Net，PHP 的 Swagger-PHP，等等。

标签： yaml swagger swagger-editor

【解决方案1】：

您可以使用 swashbuckle 代替 swagger（或旁边，但我建议只选择一个）

https://github.com/domaindrivendev/Swashbuckle.AspNetCore#getting-started

自从我使用它以来，他们更改了文档，但是您可以使用此工具扫描您的 asp.net 核心项目，查看所有控制器和路由并为您生成一个 opeapi 文档。

它还可以生成客户端代码和一堆其他东西。

【讨论】：

但是我还没有控制器，因为我的 api 仍处于设计阶段。我知道通过将 swagger 依赖项添加到您的项目中并使用 docket 方法创建配置文件，swagger 将自动生成所有内容。
如果您处于设计阶段，您应该设计 swagger/OpenApi 文件。因此，如果您处于设计阶段 - 这就是您正在设计的东西。
也就是说，没有办法在设计阶段自动生成 yaml 代码。
好吧 - 你想如何自动生成它？地球上没有生成器可以神奇地猜出你想要在那个文件中的内容。你也许是说你想要一个建模师？帮助您设计规范的可视化应用程序？
我不知道这样的工具。我自己使用了 3 种技术，基于 asp.net 核心中的控制器的自动生成，自己设计文件，并且在某些时候我还使用 swagger 站点通过向另一个 API 发送休息调用（get/post 等）来制作文档网站。我确实发现了这个； openapi.tools/#gui-editors 所以似乎有一些辅助工具可用。 apibldr.com这个看起来很整洁！