SwaggerSpringBootStarter 在 spring-boot 中使用 swagger 项目简介
在spring-boot中使用swagger,可以实现对代码无侵入地集成swagger使用时的项目配置需要在spring boot项目中使用,下面按照使用maven构建项目,以使用application.properties文件来配置进行介绍, 如果使用其他的构建工具或配置文件,做相应的变更即可在maven配置文件pom.xml中添加依赖<dependency>
<groupId>cn.songxinqiang</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>在application.properties文件中配置api的信息#配置swagger的api信息
swagger.api.name = demo-api
swagger.api.title=Demo API
swagger.api.description=SwaggerSpringBootStarter 使用样例,一切就是这么简单
swagger.api.version=2.1.1
swagger.api.contact.name = 阿信sxq
swagger.api.contact.email = [email protected]
swagger.api.contact.url = https://my.oschina.net/songxinqiang/
swagger.api.exclude-paths=/error,/admin/**其中忽略路径使用英文逗号进行分隔,可以不进行配置swagger ui在使用时的配置api的控制器会监听在地址/v2/api-docs?group=<swagger.api.name配置的值>, 对于swagger ui来说需要指定服务器的“基础地址”为项目的根地址即可需要单独准备swagger ui可以使用maven坐标为<dependency>
<groupId>cn.songxinqiang</groupId>
<artifactId>swagger-spring-boot-starter-ui</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>的webjar使用演示说明博客: https://my.oschina.net/songxinqiang/blog/1490463使用演示可以查看 https://gitee.com/songxinqiang/SpringBootSwaggerStarter-Demo
<groupId>cn.songxinqiang</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>在application.properties文件中配置api的信息#配置swagger的api信息
swagger.api.name = demo-api
swagger.api.title=Demo API
swagger.api.description=SwaggerSpringBootStarter 使用样例,一切就是这么简单
swagger.api.version=2.1.1
swagger.api.contact.name = 阿信sxq
swagger.api.contact.email = [email protected]
swagger.api.contact.url = https://my.oschina.net/songxinqiang/
swagger.api.exclude-paths=/error,/admin/**其中忽略路径使用英文逗号进行分隔,可以不进行配置swagger ui在使用时的配置api的控制器会监听在地址/v2/api-docs?group=<swagger.api.name配置的值>, 对于swagger ui来说需要指定服务器的“基础地址”为项目的根地址即可需要单独准备swagger ui可以使用maven坐标为<dependency>
<groupId>cn.songxinqiang</groupId>
<artifactId>swagger-spring-boot-starter-ui</artifactId>
<version>2.1.1.RELEASE</version>
</dependency>的webjar使用演示说明博客: https://my.oschina.net/songxinqiang/blog/1490463使用演示可以查看 https://gitee.com/songxinqiang/SpringBootSwaggerStarter-Demo