Blame view

src/main/java/com/objecteye/config/Swagger2Config.java 3.3 KB
c83b5b39   Liu Haoyu   项目创建, 集成spring-se...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
  package com.objecteye.config;
  
  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.AuthorizationScope;
  import springfox.documentation.service.SecurityReference;
  import springfox.documentation.spi.DocumentationType;
  import springfox.documentation.spi.service.contexts.SecurityContext;
  import springfox.documentation.spring.web.plugins.Docket;
  import springfox.documentation.swagger2.annotations.EnableSwagger2;
  
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * Swagger2API文档的配置
   */
  @Configuration
  @EnableSwagger2
  public class Swagger2Config {
      @Bean
      public Docket createRestApi() {
          return new Docket(DocumentationType.SWAGGER_2)
                  .apiInfo(apiInfo())
                  .select()
                  .apis(RequestHandlerSelectors.basePackage("com.objecteye.controller"))
                  .paths(PathSelectors.any())
                  .build()
                  .securitySchemes(securitySchemes())
                  .securityContexts(securityContexts());
      }
  
      private ApiInfo apiInfo() {
          return new ApiInfoBuilder()
                  .title("人像平台后台系统")
                  .description("人像平台后台模块")
                  .contact("face")
                  .version("1.0")
                  .build();
      }
  
      private List<ApiKey> securitySchemes() {
          //设置请求头信息
          List<ApiKey> result = new ArrayList<>();
          ApiKey apiKey = new ApiKey("Authorization", "Authorization", "header");
          result.add(apiKey);
          return result;
      }
  
      private List<SecurityContext> securityContexts() {
          //设置需要登录认证的路径
          List<SecurityContext> result = new ArrayList<>();
          result.add(getContextByPath("/alarm/.*"));
          result.add(getContextByPath("/capture/.*"));
          result.add(getContextByPath("/deploy/.*"));
          result.add(getContextByPath("/equipment/.*"));
          result.add(getContextByPath("/feature/.*"));
          result.add(getContextByPath("/location/.*"));
          result.add(getContextByPath("/personnel/.*"));
          result.add(getContextByPath("/preview/.*"));
          result.add(getContextByPath("/record/.*"));
          result.add(getContextByPath("/user/.*"));
          result.add(getContextByPath("/areaEquipment/.*"));
          return result;
      }
  
      private SecurityContext getContextByPath(String pathRegex) {
          return SecurityContext.builder()
                  .securityReferences(defaultAuth())
                  .forPaths(PathSelectors.regex(pathRegex))
                  .build();
      }
  
      private List<SecurityReference> defaultAuth() {
          List<SecurityReference> result = new ArrayList<>();
          AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
          AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
          authorizationScopes[0] = authorizationScope;
          result.add(new SecurityReference("Authorization", authorizationScopes));
          return result;
      }
  }