swagger-ui页面设置接口请求头head参数

左手的ㄟ右手 2024-05-02 20:21 88阅读 0赞

有时候我们http请求需要设置请求头信息，  
那么当我们用[swagger][]调试接口的时候怎么传head参数呢？

有两种方式：  
1：设置全局的请求头，对所有接口都适用

在swagger配置类中增加：

@Bean
        public Docket createRestApi() {
            ParameterBuilder tokenPar = new ParameterBuilder();
            List<Parameter> pars = new ArrayList<>();
            tokenPar.name("accessToken").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
            pars.add(tokenPar.build());
    
            ApiSelectorBuilder builder = new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.XXX"))
                    .paths(PathSelectors.any());
    
            return builder.build().globalOperationParameters(pars);
        }

2：针对单个接口，设置请求头：

@ApiImplicitParam(name = "accessToken", required = false,paramType = "header",dataType = "String")
    在接口上增加该注解即可

哪个接口需要请求头，就加此代码即可

@ApiImplicitParams注解的常见用法：  
https://blog.csdn.net/jiangyu1013/article/details/83107255

[swagger-ui页面设置接口请求头head参数\_swagger页面测试如何设置header-CSDN博客][swagger-ui_head_swagger_header-CSDN]

[swagger]: https://so.csdn.net/so/search?q=swagger&spm=1001.2101.3001.7020
[swagger-ui_head_swagger_header-CSDN]: https://blog.csdn.net/u010953880/article/details/115769378

发表评论取消回复

表情：

评论列表（有 0 条评论，88人围观）

还没有评论，来说两句吧...

相关阅读

相关 swagger-ui页面设置接口请求头head参数

有时候我们http请求需要设置请求头信息，1：设置全局的请求头，对所有接口都适用。调试接口的时候怎么传head参数呢？哪个接口需要请求头，就加此代码即可。

左手的ㄟ右手/ 2024年05月02日 20:21/ 0 赞/ 89 阅读

相关 HttpClient设置请求头

httpclient：4.5.1 httpcore：4.4.3 public static String USER_AGENT[] = {

向右看齐/ 2024年02月17日 17:13/ 0 赞/ 85 阅读

相关调用feign接口时手动设置请求头信息

调用feign接口手动设置请求头一需求场景：二解决方法 2.1 feign接口添加@RequestHeader的注解

墨蓝/ 2023年10月16日 11:08/ 0 赞/ 9 阅读

相关（已解决）如何在调用fegin接口时设置请求头header和传入参数

问题现象：最近在研究如何使用 fegin调用第三方服务接口，并设置请求头和参数，发现了方法注解@Header 、参数属性@RequestHeader 和方法注解@R

末蓝、/ 2023年01月08日 08:08/ 0 赞/ 29 阅读

相关 RESTful接口请求头参数解析

public static Map analyseRequest(HttpServletRequest request){ Map map =

﹏ヽ暗。殇╰゛Y/ 2022年08月29日 10:57/ 0 赞/ 379 阅读

相关 swaggerUI页面没有显示api

如图，没有api： ![这里写图片描述][SouthEast] 原因：basePackage写错 ![这里写图片描述][SouthEast 1] 修改错误代码

女爷i/ 2022年06月09日 09:09/ 0 赞/ 414 阅读

相关 ajax 设置请求头参数之--contentType

$.ajax({ cache: false, type: "POST",

痛定思痛。/ 2022年06月08日 07:46/ 0 赞/ 1248 阅读

相关 combobox设置请求头

<table id="product" class="easyui-datagrid" title="编辑开票信息" style="widt

小咪咪/ 2022年05月30日 06:49/ 0 赞/ 263 阅读

相关【JAVA】拦截请求参数并设置请求头

业务中遇到了一些场景，需要对请求做统一拦截，用请求参数计算新的变量设置到请求头中。以下分别用Filter和Interceptor两种方式实现，（建议使用Fi

今天药忘吃喽~/ 2022年03月25日 09:08/ 1 赞/ 1623 阅读

相关 http head头

1、HTTP请求方式如下表： <table> <tbody> <tr> <td> <p>GET</p> </td> <td> <p>向We

妖狐艹你老母/ 2022年02月22日 00:53/ 0 赞/ 206 阅读