Spring boot+Swagger配置无侵入式Restful接口(一)

最近一直遇到有人问我spring boot +swagger怎么配置无侵入式的restful接口,这段时间一直很忙,没有时间,刚好星期六,趁着休息时间给大家写个demo,在这里我就粘贴一些步骤,具体的源码我就上传到码云上面吧,在这里我使用的工具是IDEA,大家可以搜搜了解下,蛮不错的一个IDE

1.创建一个初始化,在这里为了节约基础的配置我就选spring initalizr,idea在2014就已经支持了,选择下一步,然后进行一系列选择

2.为了快速,我就不选数据库那些,只选择一个web,如果需要数据库的话,无论是关系型数据库还是非关系型数据库,支持得都还好

3.项目基础结构如下,因为自带有maven的操作,我就把这边的文件删除掉

4.添加swagger的依赖,其实页面返回的时候是json格式,还需要添加jackson的依赖,只是spring boot默认关系依赖就将jackson添加进来了

5.配置swagger

6.编写测试controller,这里我们不需要对里面的controller和方法进行swagger配置,swagger会自动扫描所有的controller,如果没有指定是请求的哪种方法,就会将七种(get,post,put,delete等等)都进行展示,如果设置了特定的请求方法,就只会展示特定的请求方法.

7.由于我其他地方使用了8080端口,所以我就使用80端口,一句话搞定,是不是特别简单,因为springboot默认集成了tomcat等容器,至于支持的版本,可以搜下官网的说明文档,要不就把tomcat升级到8.0以上,要么就手动配置tomcat的版本

8.开始运行,先clean,再package,然后再plugins里面spring-boot找到run,就可以运行了,如果你是java源文件,也可以直接找到主方法的类,run一下就okay

9.打开浏览器开始访问啦 http://localhost:端口号/swagger-ui.html,我的访问地址就是http://localhost/swagger-ui.html

10.如果正式运行项目,注释或者去掉swagger的配置和去掉对swagger的依赖即可

11.如果大家用的是spring mvc的框架的话,我后面有时间就给写个demo吧,其实原理也差不多,只是多个jackson的依赖,大家可以尝试一下

12.源代码我已上传至码云,链接地址spring boot+swagger,欢迎大家下载和交流,如果本文章有什么错误的地方,欢迎大家指出,谢谢!

13.如果你觉得这个还是太过麻烦了,接下来,是时候来一波大招了,  Spring boot+Swagger配置无侵入式Restful接口(二)