swagger设置使用及自定义安全方案securitySchemes

1.导入swagger依赖

这里使用的是springfox-boot-starter,同时导入knife4j插件（不导入也行，导入可以方便接口调试）。

1.         <dependency>
2.             <groupId>io.springfox</groupId>
3.             <artifactId>springfox-boot-starter</artifactId>
4.             <version>3.0.0</version>
5.         </dependency>
6.         
7.         <dependency>
8.             <groupId>com.github.xiaoymin</groupId>
9.             <artifactId>knife4j-spring-boot-starter</artifactId>
10.             <version>3.0.3</version>
11.         </dependency>

复制代码

接下来编写swagger设置类

1. @Configuration
2. @EnableOpenApi
3. @EnableKnife4j
4. public class Knife4jConfig {
6.     @Bean
7.     public Docket defaultApi2() {
8.         return new Docket(DocumentationType.OAS_30)
9.                 .apiInfo(apiInfo())
10.                 //分组名称
11. //                .groupName("2.X版本")
12.                 .select()
13.                 //这里指定Controller扫描包路径
14.                 .apis(RequestHandlerSelectors.basePackage(""))
15.                 .paths(PathSelectors.any())
16.                 .build()
17.                 .securitySchemes(securitySchemes())
18.                 .securityContexts(securityContexts());
19.     }
21.     private ApiInfo apiInfo() {
22.         return new ApiInfoBuilder()
23.                 .title("项目名称")
24.                 .version("1.0")
25.                 .build();
26.     }
28.     private List<SecurityScheme> securitySchemes() {
29.         List<SecurityScheme> securitySchemeList = new ArrayList<>();
30.         securitySchemeList.add(new HttpAuthenticationScheme("Authorization",
31.                 "JWT授权（数据将在请求头中进行传递)直接在下面框中输入token",
32.                 "http",
33.                 "Bearer",
34.                 "JWT",
35.                 new ArrayList<>()
36.         ));
37.         return securitySchemeList;
38.     }
40.     //过滤不需要进行验证的页面
41.     private List<SecurityContext> securityContexts() {
42.         List<SecurityContext> securityContexts = new ArrayList<>();
43.         securityContexts.add(
44.                 SecurityContext.builder()
45.                         .securityReferences(defaultAuth())
46.                         //这些接口不用提供token即可访问。
47.                         .forPaths(PathSelectors.regex("^(?!/employee/login).*$"))
48.                         .forPaths(PathSelectors.regex("^(?!/identifyImageBase64).*$"))
49.                         .build());
50.         return securityContexts;
51.     }
53.     //全局的token配置
54.     private List<SecurityReference> defaultAuth() {
55.         List<SecurityReference> securityReferences = new ArrayList<>();
56.         securityReferences.add(new SecurityReference("Authorization", new AuthorizationScope[0]));
57.         return securityReferences;
58.     }
59. }

复制代码

在swagger文档中效果如下

在/swagger-ui/index.html#/中可以全局设置token，并主动过滤不需要token的接口

在knife4j文档中也可以实现设置全局token

结束。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。