swagger添加token

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

你就像甜甜的益达

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

阅读量1.3k

点赞数

分类专栏： swagger

本文链接：https://blog.csdn.net/qq_38366063/article/details/112762530

版权

swagger 专栏收录该内容

8 篇文章 0 订阅

订阅专栏

文章目录

- 基础版本添加注意:
- 完整的配置:

基础版本添加注意:

前面这一段
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());    //根据每个方法名也知道当前方法在设置什么参数

和Docket最后添加的:
 .globalOperationParameters(pars)

完整的配置:

import java.util.ArrayList;
import java.util.List;
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.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
@Configuration
public class SwaggerConfig {

  @Bean
  public Docket createRestApi() {

    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("cn.web.controller"))
        //包下的类，生成接口文档
        .paths(PathSelectors.any())
        .build()
        .globalOperationParameters(pars)
        ;
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("web接口文档")
        .description("web 接口文档")
        .version("1.0.0")
        .build();
  }
}