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

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

所以针对JWT类型的接口,可以使用Knife4j自带的AfterScript功能,该功能是Knife4j2.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);
}
相关推荐
幽兰的天空39 分钟前
Python 中的模式匹配:深入了解 match 语句
开发语言·python
网易独家音乐人Mike Zhou4 小时前
【卡尔曼滤波】数据预测Prediction观测器的理论推导及应用 C语言、Python实现(Kalman Filter)
c语言·python·单片机·物联网·算法·嵌入式·iot
安静读书4 小时前
Python解析视频FPS(帧率)、分辨率信息
python·opencv·音视频
小二·6 小时前
java基础面试题笔记(基础篇)
java·笔记·python
朝九晚五ฺ7 小时前
【Linux探索学习】第十四弹——进程优先级:深入理解操作系统中的进程优先级
linux·运维·学习
小喵要摸鱼7 小时前
Python 神经网络项目常用语法
python
Kkooe8 小时前
GitLab|数据迁移
运维·服务器·git
一念之坤8 小时前
零基础学Python之数据结构 -- 01篇
数据结构·python
久醉不在酒9 小时前
MySQL数据库运维及集群搭建
运维·数据库·mysql
wxl7812279 小时前
如何使用本地大模型做数据分析
python·数据挖掘·数据分析·代码解释器