将Swagger OpenAPI规范添加到spring启动项目中

时间:2016-11-14 14:39:30

标签: rest swagger swagger-ui openapi

我找到了这个项目https://github.com/OAI/OpenAPI-Specification 据我所知,我们可以在.json/.yml文件中编写文档。我可以在http://editor.swagger.io/中轻松地将其呈现给.html文件。

所以我的问题 - 如何从这些文件生成静态.html页面?是否有春季启动应用程序的教程?我是否应该以某种方式将.json/.yml文件提供给swagger配置以准备好文档中的.html文件?

1 个答案:

答案 0 :(得分:4)

无需从.yml.json文件生成HTML,JavaScripts和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文件,因为它更具可读性。