欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

SpringBoot添加swagger2接口并添加全局Authorization参数

程序员文章站 2022-07-02 18:47:33
...

需求:

在项目实践中,我们需要Token值去向后端发送请求,后端根据Token值去判断用户,根据不同的用户返回对应的信息。这就是Token验证。

Token是在客户端频繁向服务端请求数据,服务端频繁的去数据库查询用户名和密码并进行对比,判断用户名和密码正确与否,并作出相应提示,在这样的背景下,Token便应运而生。Token是服务端生成的一串字符串,以作客户端进行请求的一个令牌,当第一次登录后,服务器生成一个Token便将此Token返回给客户端,以后客户端只需带上这个Token前来请求数据即可,无需再次带上用户名和密码。

那我们怎样在swagger中,写入Token值,发送swagger请求,测试这个接口呢?
 

步骤:

1. 得到用户Token(前端的任何请求都会有这个Token记录,只要不退出登录,Token没有过期,就会一直存在)

SpringBoot添加swagger2接口并添加全局Authorization参数

2. swagger2配置

 

package com.tfjybj.training.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.*;
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;

/**
 * swagger配置
 *
 * @author 景月娇
 * @version 1.0.0
 * @since 1.0.0 2019年10月8日09:01:26
 */
@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.tfjybj.training.provider.controller"))
                .paths(PathSelectors.any())
                .build()
                
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());

    }
    private List<ApiKey> securitySchemes() {
        List<ApiKey> apiKeys = new ArrayList<>();
        apiKeys.add(new ApiKey("Authorization", "Authorization", "header"));
        return apiKeys;
    }

    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.regex("^(?!auth).*$")).build());
        return securityContexts;
    }
    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
        return securityReferences;
    }


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Demo4SpringBoot APIs")
                .description("")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

3. 生成的swagger:

SpringBoot添加swagger2接口并添加全局Authorization参数

4. 添加全局Authorization参数后,先点击Authorize,再点击Close

SpringBoot添加swagger2接口并添加全局Authorization参数

5. 添加成功后:锁关闭

SpringBoot添加swagger2接口并添加全局Authorization参数

之后我们再发送需要Token验证的请求,就可以测通了!!!