springboot集成swagger3.0

背景

本文基于springboot、gradle配置，如果是maven环境，可以适当调整

依赖

compileOnly 'io.springfox:springfox-boot-starter:3.0.0'

Swagger3Config

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import io.swagger.annotations.ApiOperation;
import io.swagger.v3.oas.annotations.Operation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.SecurityScheme;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableKnife4j
public class Swagger3Config {
    @Bean
    public Docket createRestApi() {
//        Profiles profiles = Profiles.of("dev","test");
//        //通过environment.acceptsProfiles判断是否处在自己设定的环境当中
//        boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .enable(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hj.hotel.controller"))
                .apis(RequestHandlerSelectors.withMethodAnnotation(Operation.class))
                .paths(PathSelectors.any())
                .build();
//                .securitySchemes(security());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("酒店数据API文档")
                .description("restful风格")
                .termsOfServiceUrl("")
                .version("1.0.0")
                .build();
    }

    private List<SecurityScheme> security() {
        List<SecurityScheme> apiKeys = new ArrayList<>();
        apiKeys.add(new ApiKey("Authorization", "Authorization", "header"));
        return apiKeys;
    }
}

@EnableOpenApi

如果使用的是3.0，加不加@EnableOpenApi都能开启swagger，一般将此注解加在配置文件或者启动类上

访问地址

http://127.0.0.1:8080/swagger-ui/index.html