有时候为了方便测试,我们需要模拟 HTTP 外部接口的返回结果。通常情况下,我们可以使用 Nginx 测试桩来实现这个目的。然而,Nginx 的使用门槛较高,可能对一些初级开发和测试人员来说有一定的难度。相比之下,Apache ShenYu 网关的 Mock 插件可以更加便捷地从管理后台界面维护模拟返回报文。接下来,将介绍如何使用 ShenYu 网关的 Mock 插件。
目录
插件介绍
Mock 插件为请求指定响应状态码和响应体,方便进行测试。支持用户使用 SpEL 表达式生 mock 数据。使用 SpEL 表达式可能会导致执行恶意脚本或应用破坏性程序的风险,因此应尽可能在安全的环境中使用。
启用插件
进入管理后台,界面右上角用户名左边可切换中英文。打开菜单 -> 基础配置 -> 插件管理,找到 mock 插件设置状态为开启。也可直接进入第3步,在配置插件界面开启。
配置插件
进入管理后台菜单 -> 插件列表 -> Mock -> Mock,首先添加选择器。在添加选择器界面输入相关信息,名称可直接填需要 mock 的 uri 或者其它任意名称;类型默认1,匹配方式是后面多个条件之间的逻辑关系,条件默认为 uri 路径模式,填入要 mock 的 uri,也可下拉选择其它条件,执行顺序为多个选择器之间的顺序,可填1,其它选项使用默认值,点击按钮确认添加选择器:
然后为该选择器添加规则(注意:有多个选择器时,先点击选择器列表中待添加规则的选择器,避免将规则添加到其它选择器中):
本例中的选择器使用 uri 路径模式,因此为该选择器添加的规则不再需要指定 uri 条件,比如,根据 header 中某个字段的不同值设置不同的响应码 httpStatusCode 和响应体 responseContent:
响应体支持配置 {} 占位符结合 SpEL 表达、内置的一些函数和参数生成数据,也可以获取请求体中的数据设置到响应体中。比如请求体为 {"names":\[{"name":"nginx"},{"name":"shenyu"}\]},{expression|#req.json.names[1].name} 将返回 "shenyu"。。
总结
使用Apache ShenYu网关的Mock插件可以方便地从管理后台界面维护模拟返回报文。相比使用Nginx测试桩,ShenYu网关的Mock插件更加简单易用,适合初级开发和测试人员使用。希望以上介绍能够帮助大家更好地利用ShenYu网关的Mock插件进行接口测试。