REST API 测试与 JSON 格式化
为什么需要专门的 API 测试
通用 HTTP 测试可以发请求,但 REST API 有一些特定需求:请求体通常是 JSON,需要特定的 Content-Type 头,响应也是 JSON 或 XML 需要格式化阅读。Web Tools 对此做了针对性的优化。
发送 JSON 请求
测试 REST API 最常见的场景是发送 JSON 格式的 POST 请求:
- 请求方法选
POST - URL 栏填写 API 地址,例如
https://api.example.com/v1/users - 在 Header 中自动填入
Content-Type: application/json(切换到 JSON Body 模式时会自动添加) - 在 Body 编辑区输入 JSON 内容,例如:
{
"name": "test",
"email": "test@example.com"
}
- 点击「发送」
Web Tools 会在发送前自动校验 JSON 语法,如果格式错误会提示具体位置,避免发出无效请求。
响应自动格式化
API 返回 JSON 时,Web Tools 会自动做缩进格式化和语法高亮,让你可以像阅读代码一样浏览响应结构,而不是一整行挤在一起的字符串。XML 响应同样会自动格式化。
格式化后的好处:
- 嵌套层级一目了然
- 字段名和值用不同颜色区分
- 长响应可以折叠展开
常见 REST 操作
| 方法 | 典型用途 | 请求体 |
|---|---|---|
| GET | 查询资源 | 无 |
| POST | 创建资源 | 新资源的数据(JSON/表单) |
| PUT | 全量更新资源 | 完整资源数据 |
| PATCH | 部分更新资源 | 需要修改的字段 |
| DELETE | 删除资源 | 通常无 |
Web Tools 的请求方法下拉框覆盖了所有常用方法,直接选择即可。
接口调试技巧
- 保存常用请求:如果频繁测试同一个接口,可以在历史记录中快速重新发送,不用每次重新填写参数
- URL 编码:带查询参数的 URL(如
?q=hello world)中的特殊字符需要 URL 编码,Web Tools 会自动处理 - 认证头:需要 Bearer Token 时,在 Header 中加
Authorization: Bearer <token> - 超时设置:如果服务器响应较慢,可以在设置中调整请求超时时间
相关页面
- HTTP 请求测试入门 —— HTTP 测试的基础用法
- 请求头与自定义配置 —— Header、认证等配置