knife4j(swagger界面配置) 2022.3.24

knife4j(swagger界面配置)

1、config类：

@Configuration
@EnableKnife4j
@ConditionalOnProperty(prefix = "knife4j",name = "enable",havingValue = "true")//在application.yml文件中配置
public class SwaggerConfig {
    private RequestParameterBuilder RequestParameterBuilder;

    // swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage("web.controller"))
                .paths(PathSelectors.any())
                .build()
                //开启全局token
                .securityContexts(securityContext())
                .securitySchemes(securitySchemes());
    }


    // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title("框架title")
                // 创建人
                .contact(new Contact("***", "", ""))
                // 版本号
                .version("1.0")
                // 描述
                .description("API 描述")
                .build();
    }


//----------------------------下面的文件是全局token---------------------------------
    private List<SecurityScheme> securitySchemes() {

        List<SecurityScheme> list = new ArrayList();

        list.add(new ApiKey("token", "token", "header"));

        return list;

    }

    private List<SecurityContext> securityContext() {

        List<SecurityContext> list = new ArrayList();

        SecurityContext securityContext = SecurityContext.builder()

                .securityReferences(securityReferences())

                .forPaths(PathSelectors.regex("/.*"))

                .build();

        list.add(securityContext);

        return list;

    }

    List<SecurityReference> securityReferences() {

        AuthorizationScope[] authorizationScopes = new AuthorizationScope[]{new AuthorizationScope("global", "全局token")};

        List<SecurityReference> securityReferences = new ArrayList<>();

        securityReferences.add(new SecurityReference("token", authorizationScopes));

        return securityReferences;

    }

}

2、application.yml

#swagger全局配置
knife4j:
  enable: true  #是否开启Swagger
  basic:
    enable: true  #进入界面是否需要账号密码
    username: admin
    password: 123456