SwaggerSpringBootStarter在 spring-boot 中使用 swagger

在spring-boot中使用swagger，可以實現(xiàn)對代碼無侵入地集成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的控制器會監(jiān)聽在地址/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