Swagger 3 使用

官网地址：API Documentation & Design Tools for Teams | Swagger

！注意 swagger 3.0.0 最高支持的 spring-boot 版本为 2.5.5

一、 配置依赖

# maven
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>3.0.0</version>
</dependency>

# spring-boot
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

二、 添加配置文件

# properties
swagger.enable=true

# yml
swagger:
    enbale: true

三、 添加配置类

/**
 * @author 妖柒南笙丶
 * @date 2021-10-16 18:07
 *  Swagger 配置类
 */
@Configuration
@EnableOpenApi
public class SwaggerConfiguration {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 标题
                .title("ProjectName_Swagger3接口文档")
                // 描述
                .description("更多请联系开发者 yiqi")
                // 联系方式: you name, website, email
                .contact(new Contact("yiqi", "null", "null"))
                // 版本
                .version("1.0")
                .build();
    }
}

应该也可以使用配置文件进行配置，未尝试 

四、  启动

五、 注解

略