/swagger-spring-boot-starter

swagger 3.x 版本与 SpringBoot 整合,简化原生代码配置。

Primary LanguageJavaApache License 2.0Apache-2.0

swagger 3.x 版本与 SpringBoot 整合,简化原生代码配置。

简介

Swagger3.0推出了官方starterspringfox-boot-starterspringfox.documentation.enabled配置,可以一键关掉它, springfox.documentation.swagger-ui.enabled参数,可以控制ui的展示,等等。

但用惯了 https://github.com/SpringForAll/spring-boot-starter-swagger (以下简称spring-boot-starter-swagger)的starter后,直接使用官方的还需要写一部分代码,来配置。所以,本项目在springfox-boot-starter上进行了增强, 以spring-boot-starter-swagger为基础,进行了二次开发,配置项大多和spring-boot-starter-swagger一样,请放心使用。

地址

swagger3.x 和 2.x 的区别

  • swagger页面地址变更为:http://localhost:8080/swagger-ui/ (是的,不是swagger-ui.html了,后边斜杠也要加上);
  • 不需要在主类上加@EnableSwagger2注解,零配置;
  • 精简了依赖,比如guava

spring-boot-starter-swagger的差异

关于认证

如果项目中用到了Spring Security等权限控制组件,需要将以下路径添加白名单,不做鉴权:

String[] authWhiteList = {
        "/swagger-ui.html",
        "/swagger-ui/*",
        "/swagger-resources/**",
        "/v2/api-docs",
        "/v3/api-docs",
        "/webjars/**"
};