欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Spring Boot 配置Swagger

程序员文章站 2022-04-19 19:09:42
...

依赖

pom依赖

    <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

gradle

  compile 'io.springfox:springfox-swagger2:2.9.2'
  compile 'io.springfox:springfox-swagger-ui:2.9.2'

Swagger配置

@Configuration
// 开启SpringFox 对 Swagger2 的支持
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket petApi() {
        // 说明要生成的文档是swagger 2.0的
        return new Docket(DocumentationType.SWAGGER_2)
                // 生成builder,为下边做准备
                .select()
                // 定义为哪些controller或model生成文档
                .apis(RequestHandlerSelectors.any())
                // 定义哪些路径需要包含
                .paths(PathSelectors.any()).build();
    }
}

使用

http://localhost:8080/swagger-ui.html

guava的依赖问题

2.9.2及之前存在guava的依赖问题,issue,预计下个版本解决


  1. https://www.vojtechruzicka.com/documenting-spring-boot-rest-api-swagger-springfox/
  2. https://sourcegraph.com/github.com/springfox/[email protected]/-/blob/boot-swagger/src/main/java/springfoxdemo/boot/swagger/Application.java