百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分析 > 正文

java 程序员如何更高效地测试接口?

liebian365 2024-10-17 14:02 26 浏览 0 评论

现在的项目基本上都已经是前后端分离了,前后端分离需要前端工程师和后端工程师的密切配合,后端工程师必须要反复测试手里的接口没有问题才可以交付给前端工程师。

这篇文章要解决的问题就是怎么帮助后端工程师快速的测试接口。

很多开发人员用的接口测试工具是 Postman 或者是 Talend API Tester 等等 ,我之前一直使用的是 Talend API Tester 的 google 插件,一直感觉这个挺香,但是当我接触到了今天要说的测试工具之后,我把它抛弃了。


什么是 Http Client

Http Client 是 Intellij Idea 上的一款插件,这款插件是完全免费的,该插件是通过文件的方式去完成编写,测试,和结果的存储,下图是下载该插件的详细步骤:

Idea 的快捷键 command + shift +a,Windows 用户是 ctrl + shift +a , 触发 action 窗口,输入 plugins ,如图所示:



回车后,我们就进入了 Idea 的插件王国,然后点击 installed,搜索 Http Client,查看是否存在该插件,这个插件通常是内嵌在 idea 当中的,无需下载,如果没有请点击 Marketplace 下载,通常正常使用 idea 就可以使用的,如果不可以请点击下图的 enable 即可。


创建 .http 文件


创建一个你需要测试接口的文件夹,我通常喜欢在项目的 resources 文件夹下面新建一个 http 的文件夹,这个文件夹下面存放我的测试接口文件,这个根据个人习惯就好, 选中文件夹,右键选择 New -> New Http Request , 输入文件名称即可,新建的文件会有如下的信息:

# For a quick start check out our HTTP Requests collection (Tools|HTTP Client|Open HTTP Requests Collection) or
# paste cURL into the file and request will be converted to HTTP Request format.
# Following HTTP Request Live Templates are available:
# * 'gtrp' and 'gtr' create a GET request with or without query parameters;
# * 'ptr' and 'ptrp' create a POST request with a simple or parameter-like body;
# * 'mptr' and 'fptr' create a POST request to submit a form with a text or file field (multipart/form-data);


上述信息列出了我们操作的快捷键,例如在文件中快速输入 ptr // 快捷键将会快速的新建一个 json 格式的 post 请求如下:


POST http://localhost:80/api/item
Content-Type: application/json

{}


我们可以修改url ,添加请求头部信息和添加请求 json 数据等。

每一个url 的左侧都有一个执行按钮,点击就可以完成请求测试,文档编写完成以后我们还可以团队共享,团队拿到该文件可以快速测试执行,着实的方便。

每当我们在文件当中建立一个请求测试完成以后,都会有一个 log 日志生成,该日志包含了请求的全部信息,包括请求的返回值信息等,日志我们也可以用来运行测试等,所有的日志存在项目文件夹 .idea -> httpRequests 文件夹下面,如下图:



上面的 httpRequests 文件夹下面 .json 格式记录的是请求返回值, .http 格式文件记录了请求历史和请求返回值存在的 json 文件信息等。


定义全局变量


有时候我们在请求接口的时候会发现有些数据是接口之间共用的,比如项目的根 URL ,常用的请求头等,这个定义全局变量的文件是一个 json 文件,文件名固定为 http.client.env.json ,还可以是 http.client.private.env.json 的,我测试这两个名字都是行的通的,我曾经测试过使用其他的名字,都失败了,建议以上面的两个文件名来命名文件,这里有一个重点要说的是全局变量文件http.client.env.json 和我们的 .http 文件必须在相同的文件夹下,如下所示是我的 http.client.env.json 文件的内容,举例如下:


{
   "uat": {
	   "baseUrl":"https://www.baidu.com",
	   "API_KEY": "77f66b32a3224d5gagkb8349a805addaac0e",
	   "CustID": "ARL",
	   "CallID": "usrarl1"
  },

   "test": {
	    "baseUrl":"https://google.com",
	    "API_KEY": "77f66b32a3224d5bkkgj8349a805addaac0e",
	    "CustID": "ARL",
	    "CallID": "usrarl1"
  }
}

如上所示,我定义两组参数 uat test ,当我在测试运行接口的时候,我们就可以选择用哪组参数运行接口,比如我测试下面这个接口:


POST {{baseUrl}}/test
Content-Type: application/json
Content-Type: application/json
Apikey:{{API_KEY}}
callerId:{{CallID}}
custId:{{CustID}}
{
  "username": "zempty.zhao@gosstech.com",
  "password": "#######"
}

上面接口对变量的引用是使用 {{}} 的形式来引用全局变量,当运行的时候参考如下截图,我们可以选择使用哪组变量运行执行,相当方便:



每个接口方便的传 token


现在很多接口访问都需要传 token ,不断的复制黏贴真的很麻烦,现在我们来解决这个问题。现在有这样一个接口:


POST http://zempty.sg:8081/login
Content-Type: application/json

{
  "username": "zempty.zhao@gosstech.com",
  "password": "123456"
}

{% client.global.set("auth_token",response.body.token); %}


测试上面接口返回值如下:

{
  "msg": "认证通过!",
  "code": 200,
  "token": "eyJhbGciOiJSUzI1NiJ9.eyJ1c2VyIjoie1widXNlcm5hbWVcIjpcInplbXB0eS56aGFvQGdvc3N0ZWNoLmNvbVwiLFwicGFzc3dvcmRcIjpudWxsLFwidG9rZW5cIjpudWxsLFwicm9sZXNcIjpbe1wiaWRcIjoxLFwicm9sZU5hbWVcIjpcIlJPTEVfUkVBRF
}


登陆以后返回的 token 数据需要在后续的接口频繁用到,所以用到了这样以后代码写在登陆请求接口中:


{% client.global.set("auth_token",response.body.token); %}


这行代码的意思是把登陆接口返回的值设置成了全局变量,后续的一些测试接口就可以通过全局变量的方式来引用 token 就好。


下面请参考如下实例代码:


GET http://zempty.sg:8081/test1
Accept: application/json
Authorization: Bearer {{auth_token}}

上例就是通过 {{auth_token}} 来使用 token 值的。


总结


希望可以帮到你更便捷的去测试 API 接口,欢迎关注 「 zempty 笔记 」,谢谢阅读。

相关推荐

精品博文嵌入式6410中蓝牙的使用

BluetoothUSB适配器拥有一个BluetoothCSR芯片组,并使用USB传输器来传输HCI数据分组。因此,LinuxUSB层、BlueZUSB传输器驱动程序以及B...

win10跟这台计算机连接的前一个usb设备工作不正常怎么办?

前几天小编闲来无事就跑到网站底下查看粉丝朋友给小编我留言询问的问题,还真的就给小编看到一个问题,那就是win10跟这台计算机连接的一个usb设备运行不正常怎么办,其实这个问题的解决方法时十分简单的,接...

制作成本上千元的键盘,厉害在哪?

这是稚晖君亲自写的开源资料!下方超长超详细教程预警!!全文导航:项目简介、项目原理说明、硬件说明、软件说明项目简介瀚文智能键盘是一把我为自己设计的——多功能、模块化机械键盘。键盘使用模块化设计。左侧的...

E-Marker芯片,USB数据线的“性能中枢”?

根据线缆行业的研究数据,在2019年搭载Type-C接口的设备出货量已达到20亿台,其中80%的笔记本电脑和台式电脑采用Type-C接口,50%的智能手机和平板电脑也使用Type-C接口。我们都知道,...

ZQWL-USBCANFD二次开发通讯协议V1.04

修订历史:1.功能介绍1.1型号说明本文档适用以下型号:  ZQWL-CAN(FD)系列产品,USB通讯采用CDC类实现,可以在PC机上虚拟出一个串口,串口参数N,8,1格式,波特率可以根据需要设置(...

win10系统无法识别usb设备怎么办(win10不能识别usb)

从驱动入手,那么win10系统无法识别usb设备怎么办呢?今天就为大家分享win10系统无法识别usb设备的解决方法。1、右键选择设备管理器,如图:  2、点击更新驱动程序,如图:  3、选择浏览...

微软七月Win8.1可选补丁有内涵,含大量修复

IT之家(www.ithome.com):微软七月Win8.1可选补丁有内涵,含大量修复昨日,微软如期为Win7、Win8.1发布7月份安全更新,累计为6枚安全补丁,分别修复总计29枚安全漏洞,其中2...

如何从零开始做一个 USB 键盘?(怎么制作usb)

分两种情况:1、做一个真正的USB键盘,这种设计基本上不涉及大量的软件编码。2、做一个模拟的USB键盘,实际上可以没有按键功能,这种的需要考虑大量的软件编码,实际上是一个单片机。第一种设计:买现成的U...

电脑识别U盘失败?5个实用小技巧,让你轻松搞定USB识别难题

电脑识别U盘失败?5个实用小技巧,让你轻松搞定USB识别难题注意:有些方法会清除USB设备里的数据,请谨慎操作,如果不想丢失数据,可以先连接到其他电脑,看能否将数据复制出来,或者用一些数据恢复软件去扫...

未知usb设备设备描述符请求失败怎么解决

出现未知daousb设备设备描述符请求失du败解决办zhi法如下:1、按下Windows+R打开【运行】;2、在版本运行的权限输入框中输入:services.msc按下回车键打开【服务】;2、在服务...

读《飘》47章20(飘每章概括)

AndAhwouldn'tleaveMissEllen'sgrandchildrenfornotrashystep-patobringup,never.Here,Ah...

英翻中 消失的过去 37(消失的英文怎么说?)

翻译(三十七):消失的过去/茱迪o皮考特VanishingActs/JodiPicoult”我能做什么?“直到听到了狄利亚轻柔的声音,我才意识到她已经在厨房里站了好一会儿了。当她说话的时候,...

RabbitMQ 延迟消息实战(rabbitmq如何保证消息不被重复消费)

现实生活中有一些场景需要延迟或在特定时间发送消息,例如智能热水器需要30分钟后打开,未支付的订单或发送短信、电子邮件和推送通知下午2:00开始的促销活动。RabbitMQ本身没有直接支持延迟...

Java对象拷贝原理剖析及最佳实践(java对象拷贝方法)

作者:宁海翔1前言对象拷贝,是我们在开发过程中,绕不开的过程,既存在于Po、Dto、Do、Vo各个表现层数据的转换,也存在于系统交互如序列化、反序列化。Java对象拷贝分为深拷贝和浅拷贝,目前常用的...

如何将 Qt 3D 渲染与 Qt Quick 2D 元素结合创建太阳系行星元素?

Qt组件推荐:QtitanRibbon:遵循MicrosoftRibbonUIParadigmforQt技术的RibbonUI组件,致力于为Windows、Linux和MacOSX提...

取消回复欢迎 发表评论: