我找到了这个项目https://github.com/OAI/OpenAPI-Specification
据我了解，我们可以在.json/.yml 文件中编写文档。另外，我可以在http://editor.swagger.io/ 中看到它可以呈现到.html 文件中。
我的问题是 - 如何从 .json/.yml 文件生成静态的 .html 页面？有没有关于spring boot应用程序的教程？我是否应该以某种方式将.json/.yml 文件设置为招摇配置并获取带有文档的.html 文件？
【问题讨论】：
标签： rest swagger swagger-ui openapi
无需从.yml 或.json 文件生成HTML、JavaScript 和CSS 资产集合。只需将 YAML/JSON 文件传递给运行 Swagger UI 的服务器，Swagger UI 就会从这些符合 Swagger 的 API 动态生成漂亮的文档。 petstore 的例子应该会给你这个想法。
您可以使用 Jenkins 之类的构建引擎（CI/CD 服务器或其他）来自动化文档发布过程。例如，每个 REST API 存储库应至少提供这些 .yml 或 .json 文件之一（顺便说一下，这些文件由 Swagger 编辑器生成）。然后在每次推送到该存储库之后，Jenkins 将获取那些 .yml 或 .json 文件并将它们上传到您的文档服务器，在该服务器上 Swagger UI 已启动并运行。
REST API 开发人员可以与客户端开发人员共享 API 文档链接，并且可以确信 .yml 或 .json 文件中的每个更改都会反映在文档中。他们只需要推动改变。由于您需要维护那些与 Swagger 兼容的 API，我个人建议使用 .yml 文件，因为它更具可读性。
【讨论】：
yml 文件链接传递给 swagger UI