发布时间:2025-06-06
浏览次数:0
前言
接口调试是软件开发人员必须掌握的基本技能之一,一个项目的成功实施,其接口测试与调试所需的时间往往超过实际编码开发的时间,这几乎成为了开发者日常工作的常态。
工欲善其事,必先利其器。在未亲身体验IDEA REST的出色表现之前,这款插件无疑是个明智之选,它不仅提供了全面的REST功能,还具备详尽的请求历史记录功能。
然而,一旦采用IDEA REST,便无需保留,因为IDEA REST不仅涵盖了所有现有功能,更具备其他独特功能,敬请继续浏览了解。
从 到 IDEA REST
真香定律的原因有如下几个:
IDEA REST 拥有所有首要功能,包括REST控制台以及历史请求的记录功能。
再者,若某款生产工具便足以实现开发和调试功能,又何必另寻他法,转而使用另一款工具呢?
IDEA REST 不仅具备环境配置的差异化功能,而且能够实现接口响应的断言验证,还拥有脚本化处理的强大能力。
IDEA REST的请求配置可通过文件进行描述,因而得以与项目及其成员共同使用和共享。
IDEA REST 控制台
在顶层工具栏中,依次点击“Tools”选项,然后选择“HTTP”,再点击“Test Web”进行打开,此时IDEA REST控制台的界面将呈现如下所示的风格。
这个控制台所展示的功能区域与之前并无二致,涵盖了请求方式、参数以及请求头的设置。尤其是,当采用Basic认证方式时,用户只需点击图中标注的按钮,便会弹出一个输入用户名和密码的对话框,填写完毕后,这些信息会自动填充至相应位置。
历史请求记录
IDEA系统会自动将最近执行的前50个请求记录下来,并将这些记录保存在名为http--log.http的文件中,该文件被放置在项目文件夹的.idea子目录中。
通过查阅请求历史,您能够迅速定位到所需的响应并重新发起请求。文件的具体内容详见图示,而要重新发起请求,只需轻点那个启动的按钮。
若用户基于请求历史记录重新发起请求,那么该请求的执行详情及响应结果的链接将会被置于请求历史记录文件的上方位置。
创建HTTP请求脚本:前述的历史记录展示了IDEA REST请求脚本的全貌。若您是通过控制台启动的intellij idea chrome,可轻松将历史请求记录的文件复制至项目中,用作HTTP请求脚本,并与团队成员共享。若非如此,您也可新建一个以.http或.rest为扩展名的文件,IDEA将自动将其识别为HTTP请求脚本。
语法部分
### 演示POST请求
请访问{{baseUrl}},通过GET请求,参数show_env设置为1。
Accept: application/json
{
"name":"a"
}
### 演示GET请求
GET {{baseUrl}}}/post
内容类型:适用于表单数据编码的格式
id=999&value=content
每个请求体均需以三个井号键进行分隔,紧随其后的是请求的URL和参数,它们是紧密相连的。无论是通过POST方法在body中传输的参数,还是通过GET方法传递的参数,都必须进行换行处理。
环境区分
你或许已经留意到,示例中的代码并未包含实际的请求网址,而是用{{}}这样的占位符来代替。这正是IDEA REST的一大亮点,它允许开发者从特定的配置文档中提取与运行环境相关的参数设置。这种方式不仅限于占位符的替换,对于那些与接口运行环境紧密相关的请求参数,同样可以通过配置文档来进行区分。
首先,在.http脚本所在的目录中建立一个名为http-..env.json的文件;接着,文件内容应包括一级的key值,这些key值用于区分不同的环境,例如dev、uat、pro等;每个环境下的对象将包含一次HTTP请求中可获取的环境变量;您可以在HTTP请求的脚本中,通过使用{{xx}}占位符直接获取这些配置参数。
{ "uat":
{ "baseUrl": "http://gateway.xxx.cn/",
"username": "", "password": ""
}, "dev": {
"baseUrl": "http://localhsot:8888/",
"username": "",
"password": ""
}
}
在执行请求的选取过程中intellij idea chrome,IDEA会引导你挑选相应的环境配置,例如:
结果断言
IDEA REST 能够对接口返回的数据执行脚本化的验证操作,这样一来,它便从单纯的接口调试工具转变为了功能更全面的测试工具,例如:
测试顺利完成:验证响应状态为200
GET https://httpbin.org/status/200
> {%
client.test(请求执行完毕,操作顺利完成。, function() {
客户断言,响应的状态码必须等于200, "Response status is not 200");
});
%}
结果值暂存
设想一下这样的情景,当某个系统要求进行身份验证方可使用时,在使用过程中,我们是否需要首先访问登录接口,接着获取token,并将其手动复制粘贴到另一个调试接口的参数中,这样的操作实在繁琐。IDEA REST 提供了一项非常实用的功能,能够完美地解决这一问题,下面我将展示相应的脚本。
POST https://httpbin.org/post
内容类型:JSON格式
{
"user": "admin",
"password": "123456"
}
> {% client.global.set("auth_token"执行代码时,需提取响应体中的JSON格式令牌;%}
GET https://httpbin.org/headers
授权:使用认证令牌{{auth_token}}
在完成首次认证请求之后,我们便能够获取到相应的token信息;随后,我们利用脚本将其存入全局变量之中。如此一来,在后续的接口调用过程中,我们便能够通过双大括号占位符直接调用该token。
如有侵权请联系删除!
TAGS:
Copyright © 2023 江苏优软数字科技有限公司 All Rights Reserved.正版sublime text、Codejock、IntelliJ IDEA、sketch、Mestrenova、DNAstar服务提供商
13262879759
微信二维码