swagger2只对部分api加authorization

swagger2.0 给springboot项目部分接口加authorization
在Spring Boot项目中使用Swagger 2.0给部分接口加上Authorization,可以通过自定义Swagger的SecurityRequirement来实现。以下是一个简单的示例代码:

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
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 java.util.Arrays;
import java.util.List;
 
@Configuration
public class SwaggerConfig {
 
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build()
                .securitySchemes(Arrays.asList(securityScheme()))
                .securityContexts(Arrays.asList(securityContext()));
    }
 
    private SecurityScheme securityScheme() {
        return new ApiKey("Authorization", "Authorization", "header");
    }
 
    private SecurityContext securityContext() {
        return SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.regex("/api/.*")) // 只对匹配此路径的接口应用安全要求
                .build();
    }
 
    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return Arrays.asList(new SecurityReference("Authorization", authorizationScopes));
    }
}

在这个配置中,我们定义了一个名为api的Docket实例,并通过.securitySchemes()添加了一个名为Authorization的SecurityScheme,类型为ApiKey,位置在HTTP头部。然后,我们通过.securityContexts()为匹配正则表达式/api/的路径配置了一个SecurityContext,其中指定了使用上述定义的SecurityScheme。

这样,只有匹配指定路径规则的接口才会要求客户端提供认证信息。你可以根据自己的需求调整正则表达式以及安全要求应用的路径。

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
Swagger2 可以通过添全局请求参数的方式来自动添 Authorization 请求头。具体步骤如下: 1. 创建一个拦截器类,用于在请求头中添 Authorization 参数。 ```java public class AuthInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { String token = "your_token_here"; request.addHeader("Authorization", token); return true; } // 省略其他方法 } ``` 2. 在 Swagger2 配置类中添全局请求参数。 ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Autowired private AuthInterceptor authInterceptor; @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()) .globalOperationParameters(Collections.singletonList(new ParameterBuilder() .name("Authorization") .description("Authorization token") .modelRef(new ModelRef("string")) .parameterType("header") .required(true) .build())) .securityContexts(Collections.singletonList(SecurityContext.builder() .securityReferences(Collections.singletonList(SecurityReference.builder() .reference("Authorization") .scopes(new AuthorizationScope[0]) .build())) .build())) .securitySchemes(Collections.singletonList(new ApiKey("Authorization", "Authorization", "header"))); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API") .description("API documentation") .version("1.0") .build(); } // 添拦截器 @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(authInterceptor); } } ``` 在这里我们使用 `globalOperationParameters` 方法添一个全局请求参数,该参数名为 `Authorization`,类型为 `header`,并且是必须的。我们还需要使用 `securityContexts` 和 `securitySchemes` 方法来配置 Swagger2 使用该参数作为授权信息。 当我们访问 Swagger2 文档时,会自动向请求头中添 Authorization 参数。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

HiJohnnyBoy

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值