SpringBootSwaggerStarter ,用于简化在spring boot的web项目中使用swagger展示api的操作,依据spring boot官方的命名建议,在maven中使用“swagger-spring-boot-starter”的坐标。
此次升级,将版本号与spring boot版本号同步,以后发布均会使用一致的版本号字符串。
从这个版本开始自带基本配置文件,可以不自己写配置了
这次还单独准备了一个附加的组件,用于准备swagger-ui的静态资源文件,添加依赖即可
<dependency> <groupId>cn.songxinqiang</groupId> <artifactId>swagger-spring-boot-starter-ui</artifactId> <version>2.0.5.RELEASE</version> </dependency>
这个是在springfox提供的文件基础上修改的,将按钮文字切换为中文,简化介绍文字,维持使用2.8.0版本的ui样式,新版本变化较大。
升级之后在maven配置文件之中的配置就修改为
<profiles> <profile> <id>develop</id> <dependencies> <dependency> <groupId>cn.songxinqiang</groupId> <artifactId>swagger-spring-boot-starter</artifactId> <version>2.0.5.RELEASE</version> </dependency> <dependency> <groupId>cn.songxinqiang</groupId> <artifactId>swagger-spring-boot-starter-ui</artifactId> <version>2.0.5.RELEASE</version> </dependency> </dependencies> </profile> </profiles>
这就是所需的配置了,如果对描述信息自定义的话,可以在application.properties文件中添加
#配置swagger的api信息 swagger.api.name=demo swagger.api.title=Demo API swagger.api.description=SwaggerSpringBootStarter 使用样例,一切就是这么简单 swagger.api.version=2.0.4 swagger.api.contactUser=阿信sxq swagger.api.contactUrl=https://my.oschina.net/songxinqiang swagger.api.contactEmail=
这样在进行编辑或者打包的时候加上参数 develop 就可以了。
具体的说明可以参考介绍博客。