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