swagger2集成auth认证

Swagger的Maven依赖

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

Swagger相关配置

@Configuration
public class Swagger2Config {

  /**
   * swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
   * @return
   */
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        //为当前包路径
        .apis(RequestHandlerSelectors.basePackage("com.example.project"))
        //包下所有路径
        .paths(PathSelectors.any())
        .build()
        .securitySchemes(securitySchemes())
		.securityContexts(securityContexts());
  }

  /**
   * 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
   * @return
   */
  private ApiInfo apiInfo() {
      return new ApiInfoBuilder()
              //页面标题
              .title("RESTful API")
              //创建人
              .contact(new Contact("author", "", ""))
              //版本号
              .version("1.0")
              //描述
              .description("API 描述")
              .build();
  }
  
	private List<ApiKey> securitySchemes() {
		List<ApiKey> apiKeyList = new ArrayList<>();
		apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
		// apiKeyList.add(new ApiKey("access_token", "access_token", "query"));
		return apiKeyList;
	}

	private List<SecurityContext> securityContexts() {
		List<SecurityContext> securityContexts = new ArrayList<>();
		securityContexts.add(SecurityContext.builder()
				//
				.securityReferences(defaultAuth())
				// 所有包含"auth"的接口不需要使用securitySchemes
				.forPaths(PathSelectors.regex("^(?!auth).*$")).build());
		return securityContexts;
	}

	private List<SecurityReference> defaultAuth() {
		AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
		authorizationScopes[0] = new AuthorizationScope("global", "accessEverything");
		List<SecurityReference> securityReferences = new ArrayList<>();
		securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
		return securityReferences;
	}
}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值