
测试 REST API 意味着向端点发送 HTTP 请求,并检查返回的内容:状态码、响应头和响应体。你这样做是为了确认端点正常工作、查看它返回的数据的确切结构、重现一个 bug,或者在编写代码之前先探索第三方 API。你能越快发送请求并读取响应,就能越快理解这个 API。
确实存在桌面工具,但对于快速检查来说它们过于繁重。基于浏览器的测试器即时加载,无需安装、无需账户、无需配置,就能处理绝大多数日常请求。
?page=2&limit=20。Content-Type 描述请求体格式,Authorization 携带凭证,Accept 声明你期望的响应格式。每个响应都带有一个状态码,让你一眼知道发生了什么。各系列很容易记住:2xx 表示成功(200 OK、201 Created),3xx 表示重定向,4xx 表示客户端出错(404 Not Found、401 Unauthorized、400 Bad Request),5xx 表示服务器失败(500 Internal Server Error)。当 API 调用出现问题时,状态码是第一条线索。
状态码下方,响应头描述载荷,响应体包含实际数据。自动美化打印 JSON 的测试器能让响应体易于阅读,而不是一行密集的文字。
Authorization 请求头,通常是 Bearer 令牌。401 响应几乎总意味着它缺失或错误。Content-Type: application/json,并检查是否返回 201 以及响应中创建的资源。大多数失败的请求归结于几个原因:缺失或格式错误的 Content-Type 请求头、过期或缺失的认证令牌、URL 中的拼写错误或错误的查询参数、请求体中的无效 JSON。由于测试器会显示原始状态和响应,这些问题很容易诊断——如果你能清晰读取 API 的回复,它会告诉你哪里出了问题。
打开免费在线 REST API 测试器——选择方法,设置请求头和请求体,发送请求,并读取带有状态码的美化打印响应。无需注册,无需安装。