怎么在springboot项目中使用swagger-spring-boot-starter

一直使用swagger，最近发现一款在swagger基础开发的api文档接口生成框架swagger-spring-boot-starter。我们先看看他生成的效果吧。

1.加入依赖

2.添加配置

spring.swagger.enabled=true

spring.swagger.security.filter-plugin=true

# 配置

spring.swagger.api-key.key-name=myToken

# 2.0.1 版本新特性 （支持可选的 Bean 验证插件）

# 配置账号密码

spring.swagger.security.username=battcn

spring.swagger.security.password=battcn

spring.swagger.base-package=com.cornerstone.verification.controller

# 关闭 JSR

spring.swagger.validator-plugin=false

3.启动项目输入：http://localhost:8083/swagger-ui.html 会有一个登陆接口 用户密码在配置文件里配置了。

4.一些swagger有用的注释：

（1）在接口上加上这个

@ApiImplicitParams({

@ApiImplicitParam(name="domainId",value="系统number",dataType="String",required=true),

        @ApiImplicitParam(name="username",value="用户名",dataType="String",required=true),

        @ApiImplicitParam(name="password",value="密码",dataType="String",required=true),

        @ApiImplicitParam(name="redirect",value="重定向地址",dataType="String",required=false)

})

注释参数信息。

swagger 文档在日常开发中，用得比较多，往往我们都是手动配置，swagger3.0之后，直接就上了一个swagger-starter,用起来更方便了。swagger3.0发生了很多变化，比如包名、注解、访问路径等都有所变化。具体自己去体会了，我就是不多说了，直接开干。

swagger3.0项目地址: https://github.com/springfox/springfox

1.一个springboot项目

2.swagger3.0依赖

1.在springboot项目pom中添加入swagger3.0依赖

2.在启动类上加新版注解@EnableOpenApi

3.添加一个接口测试controller：

4.直接启动搞定： 注意 访问路径 http://localhost:8080/swagger-ui/index.html ，和2不一样了。

再一运行：

ok了，就搞定了。

当使用https后界面上的services地址不会随着你的项目域名变https时自动变https,如下图:

当然,这个bug官方会在3.0.1版本中修复, https://github.com/springfox/springfox/issues/3468 ，目前也是可以解决这个问题的，自定义swagger拦截器，借鉴了 https://github.com/springfox/springfox/issues/3531 ,

此时再重新启动项目:

就可以正常了，当然这只是我自己处理的一个思路，具体实现可以各抒己见。

最后的最后：demo地址: https://gitee.com/zzj1992/swagger3-demo.git

---