我找到了这个项目https://github.com/OAI/OpenAPI-Specification据我了解,我们可以在.json/.yml
文件中编写文档。另外,我可以在http://editor.swagger.io/中看到它可以呈现为.html
文件。
我的问题是-如何从.html
文件生成静态.json/.yml
页面?是否有任何有关Spring Boot应用程序的教程?我应该以某种方式将.json/.yml
文件设置为大胆的配置并获得带有文档的.html
文件吗?
无需从.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已启动并正在运行的Documentation服务器。
REST API开发人员可以与客户端开发人员共享API文档链接,也可以确信.yml
或.json
文件中的每个更改都将反映在文档中。他们只需要推动更改。由于您需要维护那些与Swagger兼容的API,因此我个人建议使用.yml
文件,仅仅是因为它更具可读性。