Spring boot+Swagger配置无侵入式Restful
maven依赖自动配置
额,看了前面第一种配置方式,是不是感觉有点麻烦呢?我也觉得,到时候去掉的时候,还需要进行删除配置啊,一大堆,还有可能到时候根本不知道.
所以,我决定自己写个让它自己就可以完成配置的东东,嗯,说干就干
这里我就不一一讲解了,具体的源码我已上传码云.码云地址maven自动配置地址
- 在pom.xml 添加maven依赖
这里需要说明一下,因为我还没有上传中央存储库,所以,直接依赖是找不到的,所以,你就下载下来,地址是(https://gitee.com/xiangyue520/swagger2), 然后进入我的这个项目根目录mvn clean install 一下,输入下面这个依赖就可以了
<dependency>
<groupId>com.wanggan</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.0.0</version>
</dependency>
- 配置
在这里我给大家提供了很多自由化的配置了,当然你也可以不用配置,因为所有的选项都是可选的
注意:如果你要进行自定义配置的话,需要默认加上前缀:
swagger.来配置属性,给个demo吧,配置的地方是application.properties或者application.yml,参数那么多,我就不一个个来了哈,可以自己配置来看看效果,其实,我都没配置完过,哈哈,要是有问题的话,请大家及时指出,以便即时更正.
swagger.title = Swagger API Demo
swagger.description = This is swagger api describle demo
swagger.version = 1.1.1
配置参数
-
title(可选) 接口的标题,具体就不多说了吧,可以自己试着玩,默认是
Swagger Restful API -
description(可选) 接口的描述,默认是
This is a swagger api desc -
version(可选) 接口的版本,默认是
1.0.0 -
groupName(可选) 接口所属的组,默认没有,当然,你可以自己写下试试
-
basePackage(可选) 扫描的包路径,默认没有,扫描下面的所有的@Controller和@RequestMapping的映射
-
termsOfService(可选) 服务条款的地址,默认没有
-
contactName(可选) 联系人,默认没有
-
contactUrl(可选) 联系的url,默认没有
-
contactEmail(可选) 联系的email,默认没有
-
licenseName(可选) 证书名,默认没有
-
licenseUrl(可选) 证书的url,默认没有
-
启动和使用
启动的话,和前面没什么区别,使用也是和前面的那种方法是一样的,打开浏览器访问http://localhost:端口号/swagger-ui.html -
移除依赖
额,这个嘛,看你项目使用profile没有,如果有的话,就一般放在
dev里面,还是一样来个demo吧
<profiles>
<profile>
<id>dev</id>
<dependencies>
<dependency>
<groupId>com.wanggan</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
</profile>
</profiles>
或者直接就放在整个pom.xml的依赖里面也行,但是一般为了减少依赖包的大小,推荐上面那种啦,这个整体的依赖就不用给demo了吧?相信你一定会的.
删除的话,就把上面这个依赖选中,删除就搞定了,要是你想以后用呢,选择注释掉也可以,看你怎么开心怎么弄.
- 后续
经历了上面的一波操作,如果还是有问题的话,就请联系我吧,嘿嘿,不是经常看,所以可能回复的比较慢,不过,应该不会遇到什么问题的,一般的问题的话,百度一下,你就知道啦.
如果你想再看看前面的自己配置的话,给个友情链接吧,Spring boot+Swagger配置无侵入式Restful接口(一)
