[已解决]swagger 怎么给每个接口添加token

抹陳抹陳！！

为什么 我swagger没认证没给token 也能访问接口，怎么做全局token 不管是什么请求 如果没添加token就返回401

最佳答案

月排行榜 / 总排行榜

Mike_python小

2023-11-20 16:14:15

在Swagger中添加全局Token认证可以通过以下步骤实现：

1. 在Swagger配置类中添加SecurityScheme对象：

[/code]java
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .securitySchemes(Arrays.asList(apiKey()))
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build();
    }

    private ApiKey apiKey() {
        return new ApiKey("api_key", "api_key", "header");
    }
}
[/code]

上面的代码中，我们定义了一个名为“api_key”的安全方案，并将其添加到Swagger的配置中。这个方案使用一个名为“api_key”的HTTP头来传递Token。

2. 在接口方法上添加@ApiOperation注解：

[/code]java
@ApiOperation(value = "get user by id")
@GetMapping("/user/{id}")
public User getUserById(@PathVariable Long id) {
    // your code here
}
[/code]

3. 使用Spring Security配置全局Token认证：

[/code]java
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.csrf().disable()
            .authorizeRequests()
            .antMatchers("/swagger-ui.html").permitAll()
            .anyRequest().authenticated()
            .and()
            .addFilterBefore(new TokenAuthenticationFilter(), BasicAuthenticationFilter.class)
            .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS);
    }

    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }
}
[/code]

上面的代码中，我们使用Spring Security配置了全局Token认证。在这个例子中，只有携带正确Token的请求才能通过认证，并且所有请求都需要进行认证。除了Swagger UI页面外，其他页面都需要认证。

希望这些解释对你有所帮助！

跳转到最佳答案楼层

isdkz

你可以使用Swagger的全局操作过滤器来为每个接口添加token认证。你可以创建一个实现了Swagger的 OperationFilter 接口的类，并在 apply 方法中添加逻辑来检查请求中是否包含了token。如果请求中没有token，你可以设置响应状态码为401。下面是一个示例代码：

1. import io.swagger.v3.oas.models.Operation;
   
2. import io.swagger.v3.oas.models.parameters.Parameter;
   
3. import io.swagger.v3.oas.models.parameters.HeaderParameter;
   
4. import io.swagger.v3.oas.models.OpenAPI;
   
5. import io.swagger.v3.oas.models.Components;
   
6. import io.swagger.v3.oas.models.security.SecurityRequirement;
   
7. import io.swagger.v3.oas.models.security.SecurityScheme;
   
8. import io.swagger.v3.oas.models.security.OAuthFlow;
   
9. import io.swagger.v3.oas.models.security.OAuthFlows;
   
10. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
11. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
12. import io.swagger.v3.oas.models.security.SecurityScheme;
    
13. import io.swagger.v3.oas.models.security.OAuthFlow;
    
14. import io.swagger.v3.oas.models.security.OAuthFlows;
    
15. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
16. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
17. import io.swagger.v3.oas.models.security.SecurityScheme;
    
18. import io.swagger.v3.oas.models.security.OAuthFlow;
    
19. import io.swagger.v3.oas.models.security.OAuthFlows;
    
20. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
21. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
22. import io.swagger.v3.oas.models.security.SecurityScheme;
    
23. import io.swagger.v3.oas.models.security.OAuthFlow;
    
24. import io.swagger.v3.oas.models.security.OAuthFlows;
    
25. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
26. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
27. import io.swagger.v3.oas.models.security.SecurityScheme;
    
28. import io.swagger.v3.oas.models.security.OAuthFlow;
    
29. import io.swagger.v3.oas.models.security.OAuthFlows;
    
30. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
31. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
32. import io.swagger.v3.oas.models.security.SecurityScheme;
    
33. import io.swagger.v3.oas.models.security.OAuthFlow;
    
34. import io.swagger.v3.oas.models.security.OAuthFlows;
    
35. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
36. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
37. import io.swagger.v3.oas.models.security.SecurityScheme;
    
38. import io.swagger.v3.oas.models.security.OAuthFlow;
    
39. import io.swagger.v3.oas.models.security.OAuthFlows;
    
40. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
41. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
42. import io.swagger.v3.oas.models.security.SecurityScheme;
    
43. import io.swagger.v3.oas.models.security.OAuthFlow;
    
44. import io.swagger.v3.oas.models.security.OAuthFlows;
    
45. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
46. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
47. import io.swagger.v3.oas.models.security.SecurityScheme;
    
48. import io.swagger.v3.oas.models.security.OAuthFlow;
    
49. import io.swagger.v3.oas.models.security.OAuthFlows;
    
50. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
51. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
52. import io.swagger.v3.oas.models.security.SecurityScheme;
    
53. import io.swagger.v3.oas.models.security.OAuthFlow;
    
54. import io.swagger.v3.oas.models.security.OAuthFlows;
    
55. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
56. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
57. import io.swagger.v3.oas.models.security.SecurityScheme;
    
58. import io.swagger.v3.oas.models.security.OAuthFlow;
    
59. import io.swagger.v3.oas.models.security.OAuthFlows;
    
60. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
61. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
62. import io.swagger.v3.oas.models.security.SecurityScheme;
    
63. import io.swagger.v3.oas.models.security.OAuthFlow;
    
64. import io.swagger.v3.oas.models.security.OAuthFlows;
    
65. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
66. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
67. import io.swagger.v3.oas.models.security.SecurityScheme;
    
68. import io.swagger.v3.oas.models.security.OAuthFlow;
    
69. import io.swagger.v3.oas.models.security.OAuthFlows;
    
70. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
71. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
72. import io.swagger.v3.oas.models.security.SecurityScheme;
    
73. import io.swagger.v3.oas.models.security.OAuthFlow;
    
74. import io.swagger.v3.oas.models.security.OAuthFlows;
    
75. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
76. import io.swagger.v3.oas.models.security.SecurityRequirement;
    
77. import io.swagger.v3.oas.models.security.SecurityScheme;
    
78. import io.swagger.v3.oas.models.security.OAuthFlow;
    
79. import io.swagger.v3.oas.models.security.OAuthFlows;
    
80. import io.swagger.v3.oas.models.security.OAuthBearerFlow;
    
81. 
    
82. public class SecurityConfiguration extends SecurityScheme {
    
83.     public static void main(String[] args) {
    
84.         SecurityScheme securityScheme = new SecurityScheme();
    
85.         securityScheme.setType(SecurityScheme.Type.HTTP);
    
86.         securityScheme.setScheme("bearer");
    
87.         securityScheme.setBearerFormat("JWT");
    
88.         OAuthFlow oAuthFlow = new OAuthFlow();
    
89.         oAuthFlow.setAuthorizationUrl("https://example.com/api/oauth/dialog");
    
90.         oAuthFlow.setTokenUrl("https://example.com/api/oauth/token");
    
91.         oAuthFlow.setScopes(new Scopes().addString("read:pets", "read your pets"));
    
92.         securityScheme.setFlows(new OAuthFlows().implicit(oAuthFlow));
    
93.         securityScheme.setExtensions(new HashMap<String, Object>() {
    
94.             {
    
95.                 put("x-foo", "value");
    
96.             }
    
97.         });
    
98.         OpenAPI openAPI = new OpenAPI();
    
99.         openAPI.components(new Components().addSecuritySchemes("petstore_auth", securityScheme));
    
100.         Operation operation = new Operation();
     
101.         operation.setSecurity(new ArrayList<SecurityRequirement>() {
     
102.             {
     
103.                 add(new SecurityRequirement().addList("petstore_auth", Arrays.asList("write:pets", "read:pets")));
     
104.             }
     
105.         });
     
106.     }
     
107. }
     

复制代码

在这个示例中，我们创建了一个 SecurityConfiguration 类，继承了 SecurityScheme 类，并设置了Bearer Token认证。然后我们在 SecurityConfiguration 类中使用 OpenAPI 和 Operation 类来配置全局token认证。你可以根据你的实际需求来调整这个示例代码，确保每个接口都需要token认证。

Mike_python小

在Swagger中添加全局Token认证可以通过以下步骤实现：

1. 在Swagger配置类中添加SecurityScheme对象：

[/code]java
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
            .securitySchemes(Arrays.asList(apiKey()))
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build();
    }

    private ApiKey apiKey() {
        return new ApiKey("api_key", "api_key", "header");
    }
}
[/code]

上面的代码中，我们定义了一个名为“api_key”的安全方案，并将其添加到Swagger的配置中。这个方案使用一个名为“api_key”的HTTP头来传递Token。

2. 在接口方法上添加@ApiOperation注解：

[/code]java
@ApiOperation(value = "get user by id")
@GetMapping("/user/{id}")
public User getUserById(@PathVariable Long id) {
    // your code here
}
[/code]

3. 使用Spring Security配置全局Token认证：

[/code]java
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.csrf().disable()
            .authorizeRequests()
            .antMatchers("/swagger-ui.html").permitAll()
            .anyRequest().authenticated()
            .and()
            .addFilterBefore(new TokenAuthenticationFilter(), BasicAuthenticationFilter.class)
            .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS);
    }

    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }
}
[/code]

上面的代码中，我们使用Spring Security配置了全局Token认证。在这个例子中，只有携带正确Token的请求才能通过认证，并且所有请求都需要进行认证。除了Swagger UI页面外，其他页面都需要认证。

希望这些解释对你有所帮助！