跳到主要内容

API调试

提示

接口已经开发完成，仅需要调试来验证接口功能，可直接使用API调试，校验接口功能。 功能分为三大功能区：请求地址、请求区、响应区

请求地址​

Method：支持下拉选择多种Method请求方式
URL：在地址栏可直接输入接口的请求地址
协议：目前支持http1.1、http2协议的发送

image.png

请求区​

可直接可视化定义接口的请求header、query等入参，当项目下的接口都有一个公共的请求参数时，可以使用全局参数的功能快速设置整个项目的公共入参。

header入参：支持下拉快速查找常用的header参数名，输入请求参数值

image.png

Query​

query入参：设置的query参数值会自动拼接到url地址中；并且可通过 = 的设置，来定义请求接口时参数值为空是否需要拼接 “=”号

image.png

Body​

body入参：支持多种数据格式 none form-data urlencode（即x-www-form-urlencoded） binary raw（json/xml/javascript/plain/html）

  1. none 格式表示body无请求正文

image.png

  1. 当你需要提交有文件的表单时，切换到 form-data

image.png

  1. 当你需要提交表单时，切换到 urlencoded

image.png

  1. 当您需要发送JSON对象或者其他对象时，切换到对应的raw类型即可 raw（json/xml）格式，支持数据结构（可以了解数据结构的使用）设计带层级接口的json或xml的入参参数值

image.png

image.png

raw（javascript/plain/html）支持源码编辑方式设计入参的参数值

image.png

Path​

支持RESTful API设计，通过在接口路径中{} 或 : 的方式增加变量，添加后也会在入参中展示出来

image.png

认证​

支持Bearer auth认证、Basic auth认证、Digest auth认证、OAuth 1.0、Hawk authentication、AWS Signature、NTLM Authentication(Beta)、Akamai EdgeGrid八种认证方式。
调试发送时统一默认是在header中添加参数。

image.png

支持直接以key-value的形式填写cookie的请求内容

image.png

预执行操作/后执行操作​

预执行操作：在接口发送前执行的操作，支持添加自定义脚本和连接数据库的操作，例如进行加解密、获取数据库数据作为入参等（可查看相关文档了解具体使用）

后执行操作：在接口发送后执行的操作，支持添加自定义脚本、连接数据库、断言、提取变量的操作，例如对响应数据进行断言、或者获取部分数据作为变量（可查看相关文档了解具体使用）

image.png

响应区​

实时响应​

image.png

代理和响应时间​

在系统设置里设置了使用代理也可在响应区内查看是否生效，可查看设置代理的使用文档

点击响应时间可以查看各个事件的耗时

提示

Request (请求): 从发出请求到开始进行套接字操作
Socket (套接字): 进行套接字操作的时间
Lookup (查找): DNS 查询的时间
Connect (连接): 建立连接到服务器的时间
SecureConnect (安全连接): SSL 安全连接建立的时间
Response (响应): 从服务器接收到响应的时间
End (结束): 结束请求的时间
Done (完成): 整个请求处理完成的时间

这些时间数据可以用来分析网络请求的性能，以确定哪个阶段花费了最多的时间，如果发现某个阶段耗时过长，就可以进行进一步的优化。

组 116@1.5x.png

控制台​

控制台可具体查看接口的请求详情，包括通过预后执行脚本打印出的内容

image.png

响应示例​

image.png

断言与校验​

image.png