如何将Spring Boot 2.x与Swagger 3完美集成?
- 内容介绍
- 文章标签
- 相关推荐
本文共计917个文字,预计阅读时间需要4分钟。
在撰写这篇记录时,Swagger的最新版本已升级至3.0.0。在集成过程中,我未注意到仍需按照2.0的集成方式进行,导致走了弯路。
目的在写这篇记录时swagger的最新版本到了3.0.0了在进行集成时没注意还按照2.0的集成在写这篇记录时swagger的最新版本到了3.0.0了在进行集成时没注意还按照2.0的集成走了一些弯路这里特记录下。
环境
一个已经搭建好的干净的springboot框架这个框架中我集成了mybatis.
什么是swagger
Swagger是一款RESTful接口的文档在线自动生成、功能测试功能框架。
一个规范和完整的框架用于生成、描述、调用和可视化RESTful风格的Web服务加上swagger-ui可以有很好的呈现。
当我们在后台的接口修改了后swagger可以实现自动的更新而不需要人为的维护这个接口进行测试。
说的再简单点传统的我们开发好接口后都会通过单元测试或者如PostMan之类的测试工具进行接口的测试在接口少的时候这个还行可是现在大家都倡导前后端分离式的开发
导致后端全是接口随着业务的复杂一个项目路的 接口不要太多每个接口我们都要去写文档而且在过程中随着业务的编写接口还会不停的更新这样我们的测试工具就显得力不从心了而且大家也知道很多公司的文档都是后补的各种各样的原因导致可能文档中的接口与实际的接口差别还挺大。。。。。
那么这个时候我们通过swagger的引入在写接口的同时通过注解的方式在接口上写明接口的作用参数介绍等那么会在线生成一个接口 文档而且还可以直接进行测试还是随着实际的接口变动实时更新的这个是不是挺美的。
本文共计917个文字,预计阅读时间需要4分钟。
在撰写这篇记录时,Swagger的最新版本已升级至3.0.0。在集成过程中,我未注意到仍需按照2.0的集成方式进行,导致走了弯路。
目的在写这篇记录时swagger的最新版本到了3.0.0了在进行集成时没注意还按照2.0的集成在写这篇记录时swagger的最新版本到了3.0.0了在进行集成时没注意还按照2.0的集成走了一些弯路这里特记录下。
环境
一个已经搭建好的干净的springboot框架这个框架中我集成了mybatis.
什么是swagger
Swagger是一款RESTful接口的文档在线自动生成、功能测试功能框架。
一个规范和完整的框架用于生成、描述、调用和可视化RESTful风格的Web服务加上swagger-ui可以有很好的呈现。
当我们在后台的接口修改了后swagger可以实现自动的更新而不需要人为的维护这个接口进行测试。
说的再简单点传统的我们开发好接口后都会通过单元测试或者如PostMan之类的测试工具进行接口的测试在接口少的时候这个还行可是现在大家都倡导前后端分离式的开发
导致后端全是接口随着业务的复杂一个项目路的 接口不要太多每个接口我们都要去写文档而且在过程中随着业务的编写接口还会不停的更新这样我们的测试工具就显得力不从心了而且大家也知道很多公司的文档都是后补的各种各样的原因导致可能文档中的接口与实际的接口差别还挺大。。。。。
那么这个时候我们通过swagger的引入在写接口的同时通过注解的方式在接口上写明接口的作用参数介绍等那么会在线生成一个接口 文档而且还可以直接进行测试还是随着实际的接口变动实时更新的这个是不是挺美的。

