当前位置: 首页 > article >正文

Knife4j调试全局对象参数自动化

Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,其中具备了在线调试功能,但是在许多场景当中需要在请求头或者请求体当中携带认证信息,这样就会增加调试的繁琐性。

所以针对JWT类型的接口,可以使用Knife4j自带的AfterScript功能,该功能是Knife4j2.0.6版本开始新增的一项特性功能,在每个接口进行调试Tab中,开发者可以根据Knife4j提供的全局变量,在接口调用之前编写一段JavaScript脚本,当接口调用成功后,Knife4j会执行该脚本。

举个栗子,当调用登录接口后,每个接口请求时带上authorization参数,此时可以通过该脚本动态赋值全局authorization参数,省去复制粘贴的麻烦。

AfterScript演示

全局对象

Knife4j目前主要提供ke(Knife4j Environment)对象来获取或者操作全局对象,主要包含的对象:

  • global: 全局操作,可以获取或者设置目前的全局参数
    • setHeader(name,value): 设置当前逻辑分组下的全局参数Header请求头
    • setAllHeader(name,value): 设置所有逻辑分组下的全局参数Header请求头
    • setParameter(name,value): 设置当前逻辑分组下,主要是针对query类型参数进行设置全局设置。
    • setAllParameter(name,value): 设置所有逻辑分组下的全局参数,主要是query类型
  • response: 当前请求接口响应内容
    • headers: 服务端响应Header对象,注意,此处所有的header的名称全部进行小写转换
    • data: 服务端响应数据(json/xml/text等等)
ke={
    global:{
        setHeader:function(name,value){
  
        },
        setAllHeader:function(name,value){
  
        },
        setParameter:function(name,value){
  
        },
        setAllParameter:function(name,value){
  
        }
    },
    response:{
        headers:{
  
        },
        data:{
  
        }
    }
}

代码示例

获取服务端响应的Header参数

当我们调用API接口后,开发者如果想拿到服务端写出的响应Header头Content-Type,并且进行控制台输出打印,可以这样编写AfterScript

var contentType=ke.response.headers["content-type"];
console.log("响应ContentType:"+contentType)

根据服务端响应的值设置全局Header

假设某一个接口响应的JSON内容如下:

{
  "code": 200,
  "msg": "成功获取访问令牌",
  "data": "43ebda13-16e2-4e26-84f2-4cade5ae86f0",
  "time": "2024-11-12T16:18:50.602521"
}

该接口是登录接口,每个接口请求都需要带上authorization的请求头,因此我们访问登录接口后,设置全局Header参数authorization,代码如下:

var code = ke.response.data.code;

//判断,如果服务端响应code是200才执行操作
if( code == 200 ){
    // 获取token
    var token = ke.response.data.data;

    //1、如过需要设置的参数是Header,则设置全局Header
    ke.global.setAllHeader("authorization", token);

    //2、如过需要设置的参数是query类型,则设置全局Parameter
    ke.global.setAllParameter("authorization", token);
}

http://www.kler.cn/a/391292.html

相关文章:

  • FastAPI 与 SQLModel 分页功能实现指南
  • 虚幻引擎是什么?
  • Centos7中使用yum命令时候报错 “Could not resolve host: mirrorlist.centos.org; 未知的错误“
  • 2. SQL窗口函数使用
  • 国标GB28181视频监控平台与Liveweb视频监控汇聚平台对接方案
  • Docker 设置代理的三种方法(2024年12月19日亲自测试)
  • A算法详解(go实现)
  • 【服务器】本地安装X11 服务器-Windows
  • 【学习】【HTML】HTML、XML、XHTML
  • Spring Boot编程训练系统:核心特性与实现策略
  • 《JVM第10课》内存溢出(OOM)排查过程
  • Rust 生态系统的未来与学习方向
  • 【Android、IOS、Flutter、鸿蒙、ReactNative 】约束布局
  • 鸿蒙进阶-属性动画
  • 移远通信亮相骁龙AI PC生态科技日,以领先的5G及Wi-Fi产品革新PC用户体验
  • 【缓存策略】你知道 Cache Aside(缓存旁路)这个缓存策略吗
  • 在JPA和EJB中用乐观锁解决并发问题
  • 前端模拟面试:7个JavaScript数组进阶面试题
  • 为什么go语言使用log.Fatalf打印日志导致程序退出
  • 第二天python笔记
  • 「实战应用」如何用图表控件LightningChart .NET在WPF中制作表格?(二)
  • 如何查看电脑关机时间
  • 《JavaEE进阶》----20.<基于Spring图书管理系统①(登录+添加图书)>
  • Redis7:商户查询缓存1
  • 【Linux-进程信号】信号入门介绍
  • 网络安全CTF竞赛模式、题目类别、所用工具小结