SpringBoot添加swagger2接口文档并添加全局Authorization参数

蔚落 2022-11-15 11:35 606阅读 0赞

**目录**

一、依赖包

二、配置类（securitySchemes与securityContexts作用为配置全局Authorization参数）

三、实际效果截图

--------------------

# 一、依赖包 #

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

# 二、**配置类（securitySchemes与securityContexts作用为配置全局Authorization参数）** #

@Configuration
    @EnableSwagger2
    public class SwaggerConfig {
        //http://localhost:9007/swagger-ui.html
        @Bean
        public Docket createRestApi() {
     
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("cn.com.dinglisec.iot.uaa.api"))
                    .paths(PathSelectors.any())
                    .build()
                    .securitySchemes(securitySchemes())
                    .securityContexts(securityContexts());
        }
     
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("springboot利用swagger构建api文档")
                    .description("简单优雅的restful风格")
                    .termsOfServiceUrl("")
                    .version("1.0")
                    .build();
        }
     
        private List<ApiKey> securitySchemes() {
            List<ApiKey> apiKeys = new ArrayList<>();
            apiKeys.add(new ApiKey("Authorization", "Authorization", "header"));
            return apiKeys;
        }
     
        private List<SecurityContext> securityContexts() {
            List<SecurityContext> securityContexts = new ArrayList<>();
            securityContexts.add(SecurityContext.builder()
                    .securityReferences(defaultAuth())
                    .forPaths(PathSelectors.regex("^(?!auth).*$")).build());
            return securityContexts;
        }
     
        private List<SecurityReference> defaultAuth() {
            AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
            AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
            authorizationScopes[0] = authorizationScope;
            List<SecurityReference> securityReferences = new ArrayList<>();
            securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
            return securityReferences;
        }
     
    }

# 三、实际效果截图 #

截图1：

![2021033117233768.png][]

![20210331172452689.png][]

截图2：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhenljaGVlcnVw_size_16_color_FFFFFF_t_70][]

截图3：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhenljaGVlcnVw_size_16_color_FFFFFF_t_70 1][]

[2021033117233768.png]: /images/20221022/c87350318e5f4b43b59478694b2d7da6.png
[20210331172452689.png]: /images/20221022/4d3b7d7b6bf449dc82ef54fccd2f9beb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhenljaGVlcnVw_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210331172231389.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhenljaGVlcnVw,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhenljaGVlcnVw_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20210331172315835.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhenljaGVlcnVw,size_16,color_FFFFFF,t_70