核心内容摘要
16岁的风，吹拂着青春的秘密花园
PostIn是一款开源免费的接口管理工具包含项目管理、接口调试、接口文档设计、接口数据MOCK、接口测试、测试计划等模块支持免费私有化部署一键安装零配置支持免登陆本地接口调试。
本文将介绍如何对接口进行快速便捷调试。
接口调试Postin 接口调试支持 HTTP 和 WebSocket 协议帮助开发者验证 API 接口的功能确保接口按预期工作。
接口调试HTTP和WebSocket协议在接口调试页面区别。
协议区别HTTP需要选择HTTP请求方式GET、POST、HEAD、PUT、DELETE、PATCH请求体遵循特定内容类型如 application/json、multipart/form-data 等数据格式与 Content-Type 头严格绑定。
支持前置脚本、后置脚本、断言等操作。
包含完整响应头。
WebSocket请求体支持文本UTF-8编码和二进制格式数据帧直接传输无需附加 Content-Type 等头信息。
无独立响应头。
1 HTTP协议HTTP协议客户端发起请求后服务器返回响应即断开连接每次通信需重新建立连接。
在接口调试页面选择HTTP协议界面显示HTTP协议接口调试需要的项目。
新建接口调试页签接口调试页面点击tabs页右侧的“”号添加一个新的接口调试tabs。
接口调试页签选择请求方式选择“HTTP”协议显示请求方式下拉框输入需要测试接口的请求方式支持的请求方式包含GET、POST、HEAD、PUT、DELETE、PATCH。
请求方式输入请求地址在地址栏中输入需要测试的接口地址接口调试需要输入包括主机和路径等信息。
输入请求参数在相应的输入框或表单中输入需要传递给接口的请求参数。
这些参数可以包括查询参数、请求体参数、请求头等根据接口的需求进行输入。
请求参数请求参数属性描述Header位于HTTP请求的头部用于传递元数据。
Query出现在URL问号后对资源进行筛选、排序或分页。
Path嵌入在URL路径中明确标识资源的唯一路径。
Body位于HTTP请求的正文用于传递实际数据。
其中Body类型及其用途如下。
属性描述none不设置请求Body。
form-data上传文件或同时提交文本和文件。
x-www-form-urlencoded提交简单的键值对表单数据适用于传统 HTML 表单提交。
jsonRaw 的子集严格遵循JSON语法键值对、双引号、嵌套结构等用于结构化数据传输。
raw原始数据格式支持任意文本内容如JSON、XML、纯文本等。
发送测试点击界面上的发送按钮将测试请求发送给目标接口。
系统将会使用输入的请求地址和参数发送请求并等待接收到服务器的响应。
查看测试结果在接收到服务器的响应后系统会将响应结果显示在界面上包括响应状态码、响应体内容等信息。
用户可以在界面上直接查看测试结果以便进行验证和调试。
2 WebSocket协议WebSocket协议连接建立后客户端与服务器可双向实时传输数据无需重复握手。
在接口调试页面选择WebSocket协议界面显示WebSocket协议接口调试需要的项目。
新建接口调试页签接口调试页面点击tabs页右侧的“”号添加一个新的接口调试tabs。
选择协议输入请求地址选择“WS”协议在地址栏中输入需要测试的接口地址包括主机和路径等信息。
这是发送测试请求的第一步确定要测试的接口地址。
选择WebSocket协议建立连接要与服务器进行通信你首先需要建立一个 WebSocket 连接。
只需点击“连接”按钮即可。
连接连接成功后服务器会对此作出响应。
输入请求参数在请求栏输入需要传递给接口的请求参数。
这些参数可以包括查询参数、请求体参数、请求头。
请求参数属性描述请求头位于接口请求的头部用于传递元数据。
查询参数出现在URL问号后对资源进行筛选、排序或分页。
请求体位于接口请求的正文用于传递实际数据。
发送测试点击界面上的发送按钮将测试请求发送给目标接口。
系统将会使用输入的请求地址和参数发送请求并等待接收到服务器的响应。
查看测试结果在接收到服务器的响应后系统会将响应报文显示在界面上。
用户可以在界面上直接查看测试结果以便进行验证和调试。
前置脚本在接口请求发送之前执行主要用于准备测试数据、动态修改请求参数或设置环境变量。
例如使用前置脚本设置请求头参数ticket。
pi.header.set(key,value) //设置请求头pi.query.set(key,value) //设置查询参数pi.body.form.set(key,value) //设置请求体pi.body.urlencoded.set(key,value) //设置请求体前置脚本或者还可以设置一些其他前置脚本。
例如生成随机用户ID和当前日期并将生成的数据写入请求体表单中 。
// 这个脚本为表单数据请求设置字段// 生成随机用户IDconst userId Math.floor(Math.random() *
;// 获取当前日期并格式化const currentDate new Date().toISOString().split(T)[0];// 准备表单数据pi.body.form.set(username, user_${userId});pi.body.form.set(email, user_${userId}example.com);pi.body.form.set(registrationDate, currentDate);
后置脚本在接口请求发送之后执行主要用于解析响应数据、断言校验、清理测试数据或传递参数给后续请求。
pi.response.get() //获取响应体pi.response.getStatusCode() //获取响应状态码例如登录接口取响应体json中data.ticket将动态值存储至环境变量ticket中后续通过引用。
// 取响应jsonconst responseJson pi.response.get();//找到json文件data下的ticketconst ticket responseJson.data.ticket;后置脚本
断言支持可视化断言在接口调试点击断言显示需要输入断言的来源状态码、响应体、响应头、属性名称、比较符、参数值。
添加完成之后调试接口在接口响应栏下断言tab显示断言是否成功。
验证基础状态检查接口返回的HTTP状态码是否符合预期如200表示成功以及验证响应头中的关键信息如Content-Type格式是否正确。
响应码断言校验响应内容包括验证响应体中是否包含特定字符串、JSON字段值是否匹配预期或直接对比整个响应体与预设字符串是否完全一致。
响应体断言例如如上图的断言显示执行成功。
调试历史接口每一次调试都会记录在左侧接口调试历史列表点击调试历史列表右侧显示调试时设置的参数。
调试历史列表点击调试历史右侧的删除按钮可以对调试历史进行删除。
点击接口调试列表右上角“扫把”按钮清空调试历史列表。
删除调试历史有兴趣的朋友可以前往官网体验下载或者下载私有化部署版本安装使用。