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

有时候我们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

  • 2
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
Swagger-UI在线接口文档的优点包括以下几个方面: 1. 支持接口文档导出:Swagger-UI可以将接口文档以PDF、Word和Markdown等格式导出,方便开发者进行离线查阅和分享。[2] 2. 多种方式使用:Swagger-UI可以与其他工具同时使用,比如springfox-swagger-ui,可以根据项目需求选择最适合的方式。[2] 3. 友好的界面:相比于springfox-swagger-uiSwagger-UI的界面更加友好,排版结构更加清晰,使得接口文档更易于理解和使用。[2] 4. 搜索功能:Swagger-UI支持接口内容的搜索,可以快速定位到需要查找的接口,提高了开发效率。[2] 5. 接口版本管理:Swagger-UI可以对接口进行版本管理,方便开发者对接口进行更新和维护。[2] 6. 国际化支持:Swagger-UI支持多语言界面,可以根据用户的语言偏好进行界面显示。[2] 7. 自定义文档:Swagger-UI支持开发者对接口文档进行自定义,可以根据项目需求添加额外的信息和说明。[2] 8. 生产环境屏蔽:Swagger-UI支持在生产环境中屏蔽Swagger的所有资源接口,保护接口文档的安全性。[2] 9. 接口权限控制:Swagger-UI可以设置在线接口文档的权限控制,限制不同用户对接口文档的访问权限。[2] 综上所述,Swagger-UI在线接口文档具有导出、多种使用方式、友好界面、搜索功能、版本管理、国际化支持、自定义文档、生产环境屏蔽和权限控制等优点。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值