https://github.com/dudiao/swagger-spring-boot-starter

swagger 3.x 版本与 SpringBoot 整合，简化原生代码配置。
https://github.com/dudiao/swagger-spring-boot-starter

spring-boot swagger

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dudiao/swagger-spring-boot-starter
• Owner: dudiao
• License: apache-2.0
• Created: 2020-10-11T15:37:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-08T17:28:11.000Z (over 4 years ago)
• Last Synced: 2025-01-25T14:42:04.732Z (4 months ago)
• Topics: spring-boot, swagger
• Language: Java
• Homepage:
• Size: 19.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

# 简介

Swagger3.0推出了官方starter`springfox-boot-starter`，`springfox.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`一样，请放心使用。

## 地址

- Github：https://github.com/dudiao/swagger-spring-boot-starter

- Gitee: https://gitee.com/songyinyin/swagger-spring-boot-starter

## swagger3.x 和 2.x 的区别

- swagger页面地址变更为：`http://localhost:8080/swagger-ui/` （是的，不是swagger-ui.html了，**后边斜杠也要加上**）；

- 不需要在主类上加`@EnableSwagger2`注解，零配置；

- 精简了依赖，比如`guava`

## 和`spring-boot-starter-swagger`的差异

## 关于认证

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

```java

String[] authWhiteList = {

        "/swagger-ui.html",

        "/swagger-ui/*",

        "/swagger-resources/**",

        "/v2/api-docs",

        "/v3/api-docs",

        "/webjars/**"

};

```