API Client 文档

Unfour API Client 可在当前工作区中构建、发送、保存和检查 HTTP 请求,并共享变量、请求脚本、历史和 OpenAPI 集合交换能力。

创建并发送请求

  1. 打开 API Client 并创建一个请求标签页。
  2. 选择 GET、POST、PUT、PATCH、DELETE、HEAD 或 OPTIONS,然后输入 URL。
  3. 添加启用的查询参数与请求头。认证可选择 No Auth、Bearer Token、Basic Auth,或放在请求头/查询参数中的 API Key。
  4. 请求体可选择 none、原始 JSON/文本或 x-www-form-urlencoded 字段。
  5. 点击 Send。解析后的请求会在本地发送,历史记录中的敏感字段会被脱敏。

集合与文件夹

集合是保存 API 请求的顶层分组。文件夹用于在集合中组织请求,也可以嵌套。一个保存的请求属于一个集合,并可选择所属文件夹。

  • 从 API 侧边栏创建或重命名集合。
  • 通过树操作创建、重命名、移动、排序或删除文件夹和请求。
  • 使用 Save 将当前请求保存到集合和可选文件夹。
  • 需要保留原请求时,先复制保存的请求再修改。

环境与变量

变量属于工作区。工作区全局变量提供默认值,当前环境覆盖特定目标的值;API 请求使用最终解析结果。

变量语法
{{base_url}}/v1/users/{{user_id}}
  1. 打开工作区环境编辑器并创建变量。
  2. 为不同目标创建环境,再从标题栏把所需环境设为当前环境。
  3. 在 URL、请求头、查询值、认证字段、请求体和受支持的脚本中使用 {{variable}}。
  4. 发送前复核当前环境,避免请求错误的服务。

检查响应

状态与响应体

查看 HTTP 状态、响应大小,以及格式化或原始响应体。

响应头与 Cookie

在独立标签中检查响应头和解析后的 Cookie。

耗时与请求

查看总耗时以及实际发送的已解析请求快照。

历史

打开脱敏后的请求/响应历史,并在请求标签页中复用。

脚本

保存的请求可以在发送前和收到响应后运行受限 JavaScript。当前脚本接口有明确边界,不代表完整兼容 Postman scripting API。

  • 请求前脚本可调整即将发送的请求,并读写受支持的工作区或环境变量。
  • 响应后脚本可检查响应、记录测试,并向专用 Console 输出内容。
  • 响应标签中会显示测试、控制台输出、脚本状态、耗时、超时与错误。
  • 请求前脚本失败会阻止 HTTP 请求;响应后脚本失败不会隐藏已经收到的响应。

导入与导出

可以导入 OpenAPI 3.x JSON 或 YAML 文档来创建集合,也可以把集合导出为 OpenAPI 3.1 JSON 或 YAML。