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

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

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

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

全局对象

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等等)
javascript 复制代码
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

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

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

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

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

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

javascript 复制代码
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);
}
相关推荐
汤姆宝库10 小时前
RoPE旋转位置编码的实现与长上下文外推
python·深度学习·机器学习
用户0190275816110 小时前
股票代码格式对照:各数据源代码转 AlphaFeed
python
宽海智能仓储物流10 小时前
宽海智能WCS系统常见问题全解析:从选型对接、运维定制到降本增效
运维·数据仓库·自动化
无奈笑天下10 小时前
银河麒麟上DHCP无法获取IP地址问题处理
linux·运维·服务器·网络协议
惜.己11 小时前
uiautodev 的安装以及使用(移动端自动化工具)
自动化
__underline__11 小时前
冷门Python知识点005篇:list.sort( )的排序稳定性,是用0字节额外内存实现的
python·算法
贝壳69011 小时前
升到 9.13.12 我照着文档抄了两行,两次都炸了
python
分布式存储与RustFS11 小时前
Rivet 的 Agent 状态存进自建 RustFS:主桶配置与上线边界
运维·云原生·开源·对象存储·分布式存储·s3·性能基准
蜗牛一步步往上爬11 小时前
第六章 使用Linux环境变量
linux·运维
VIP_CQCRE11 小时前
AI 音乐 API 上线后成本失控?用预算阈值、幂等任务和音频验收管住 Suno v6
python·api·suno·ai音乐·成本治理