swagger 添加Token

最新推荐文章于 2024-07-22 16:00:00 发布

qq_41987575

最新推荐文章于 2024-07-22 16:00:00 发布

阅读量1.2w

点赞数 4

本文链接：https://blog.csdn.net/qq_41987575/article/details/94736891

版权

后台有权限认证是springboot+jwt+shiro+swagger的，swagger配置token

1 首先在pom文件引入依赖：

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

接下来：下面代码中

.globalOperationParameters(pars); 是添加前面四行的进去的，前四行是swagger配置token的 代码中有注释

package com.example.dscjwtshrio.config;

import com.google.common.collect.Lists;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
//        ParameterBuilder tokenPar = new ParameterBuilder();
//
//        List<Parameter> pars = new ArrayList<>();
//        tokenPar.name("Authorization").description("token!").modelRef(new ModelRef("string")).parameterType("header").required(false).defaultValue("").build();
//        pars.add(tokenPar.build());

        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        ticketPar.name("Token").description("user ticket")//Token 以及Authorization 为自定义的参数，session保存的名字是哪个就可以写成那个
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build(); //header中的ticket参数非必填，传空也可以
        pars.add(ticketPar.build());    //根据每个方法名也知道当前方法在设置什么参数

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.dscjwtshrio"))
                .paths(PathSelectors.any())
                .build()
//                .securitySchemes(Lists.newArrayList(apiKey()))
                .globalOperationParameters(pars);
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("数据平台接口中心")
                .description("数据平台接口中心")
                .termsOfServiceUrl("http:www.baidu.com/")
                .contact("www")
                .version("1.0.1")
                .build();
    }
//    private ApiKey apiKey() {
//        return new ApiKey("apikey", "Authorization", "header");
//    }
}

3 接下来访问：http://localhost:8080/swagger-ui.html#!/

4 此时会出现下面这个，然后将token穿进去即可