用 REST 客户端测试 API

方法、URL、发送

顶部有三个控件。左侧的方法选择器是一个下拉菜单,包含 GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS——每个都有颜色编码(GET 绿、POST 蓝、PUT 橙、PATCH 黄、DELETE 红、HEAD 紫、OPTIONS 灰),让你一眼就能看出某个请求会做什么。旁边是 URL 输入框(占位文本 https://api.example.com/endpoint)。右侧是发送按钮——URL 为空时它会被禁用,而在请求进行中它会显示一个旋转图标而不是"发送"字样,让你知道它正在工作。

读懂响应窗格

把方法保持为 GET,粘贴一个真实的 URL——试试一个公开的,比如 https://api.github.com/repos/anthropics/anthropic-sdk-python——然后点击发送。右侧窗格会填充内容。在你发送任何东西之前,它显示一个占位提示("Send a request to see the response");响应到达后,你会得到一个含四项信息的状态栏:

• 加粗的状态码——成功(2xx)为绿色、失败为红色——下方是状态文本(例如 200 OK)。
• 以毫秒为单位的响应时间,方便你发现慢的接口。
• 响应体大小,以字节 / KB / MB 格式显示。

状态栏下方有一个小切换器,在 Body(原始响应文本,等宽字体且可选中)和 Headers(所有响应头,按字母排序,键为强调色、值在旁边)之间切换。如果请求彻底失败——主机错误、无网络——你会看到一个警告图标和错误信息,而不是状态栏。

Headers 标签

请求主体的左侧有两个标签:Headers 和 Body。在 Headers 标签里,每个请求头是一行,含四部分:一个复选框用于启用或禁用该头而无需删除、一个键(Key)字段、一个值(Value)字段,以及一个减号按钮用于删除该行。点击底部的 Add Header 添加一个空行。

对于需要鉴权的请求,添加一行,键为 Authorization、值为 Bearer <你的-token>。调试时启用复选框很好用:把某个头关掉、重新发送,看看它是不是原因——无需重新输入。

Body 标签

把方法切换为 POST,然后点击 Body 标签。这里有一个请求体类型选择器;当类型设为 None 时,编辑器只显示 "No body"。选择一个内容类型后会出现一个等宽编辑器——在那里粘贴你的原始 JSON,例如:

{
  "name": "widget",
  "quantity": 3
}

在 Headers 标签上加一个 Content-Type: application/json 请求头,让服务器解析它,然后点击发送。响应窗格的更新方式和 GET 完全一样——状态、耗时、大小、响应体、响应头。

历史栏

一旦你发送过至少一个请求,标签底部就会出现一个历史(History)栏——一排横向的胶囊,展示你最近的 10 个请求。每个胶囊显示方法(带颜色编码)和缩短后的 URL。点击一个胶囊,即可把那个请求——方法、URL,全部——加载回编辑器,方便你重发或微调。这是在你正在对比的两个接口之间来回切换的最快方式。