REST API 客户端

发送 HTTP、GraphQL 和 WebSocket 请求,支持环境、集合与历史记录。

本页内容 8 个小节

发送请求

  1. 在命令面板中运行 DevSnip Pro: REST API Client,或在侧边栏中点击它。
  2. 选择方法、输入 URL,然后按 Enter 或点击 Send。
  3. 查看响应:状态码、耗时和大小,可搜索的格式化 JSON,以及响应头和 Cookie。可以从工具栏复制或保存响应。
提示

把 cURL 命令(例如浏览器开发者工具中的 Copy as cURL)粘贴到 URL 栏:方法、请求头和请求体都会被导入。

用环境代替写死的主机和令牌

为每个目标创建一个环境,例如 local 和 staging,并设置 baseUrl、token 等变量。在请求的任何位置用 {{name}} 引用它们,然后切换环境,即可对另一台服务器运行同一个请求。

Request
GET {{baseUrl}}/users/42
Authorization: Bearer {{token}}

认证

在 Auth 标签页中选择 Bearer、Basic 或 API key。OAuth 2.0 令牌助手作为高级工具提供。

集合与历史记录

  • 把请求保存到集合中,并按与 API 结构对应的文件夹分组(auth/、users/、billing/)。集合数量不限,保存在本地。
  • 历史记录会保存你发送过的每个请求;看起来像凭据的 URL 值会被隐藏,API 密钥绝不会写入历史记录。

测试 GraphQL API

  1. 将协议从 HTTP 切换为 GraphQL(位于请求名称旁边)。Body 标签页会变成 Query 标签页。
  2. 将方法设为 POST,并输入端点,例如 {{baseUrl}}/graphql。
  3. 编写查询,添加 Variables (JSON);如果文档包含多个操作,还需填写 Operation name。
  4. 按 Ctrl/Cmd+Enter 或点击 Send,然后同时检查响应中的 data 和 errors。
Query
query GetCountry($code: ID!) {
  country(code: $code) {
    name
    capital
  }
}
示例:变量与响应

把 $code 的值放入 Variables (JSON):

Variables
{
  "code": "GB"
}

响应中的 data 与查询的结构一致。即使查询的一部分失败,GraphQL 服务器也常常返回 200 OK,并在 errors 数组中列出问题,所以两者都要检查:

Response
{
  "data": {
    "country": {
      "name": "United Kingdom",
      "capital": "London"
    }
  }
}

把请求转换为代码

  • 为 JavaScript(fetch、Axios)、Python、Go、Java 或 C# 生成代码。
  • 导出为 cURL,用于 README 或问题报告。
  • 使用 JSON to Types 从响应生成类型(TypeScript、Zod、Pydantic、Go、Kotlin、Swift 等)。

调用 AI 服务

为 OpenAI、Anthropic、Gemini、Azure OpenAI、Ollama 以及任何兼容 OpenAI 的端点预置请求模板。发送提示词、以流式方式接收回复,并按 Schema 校验;你的 API 密钥只用于本次请求,绝不会被保存。

高级工具

断言、请求链、批量性能测试、响应对比、Mock 服务器、WebSocket、OAuth 2.0 助手和带类型的 SDK 导出,每次成功运行花费 8–35 积分。积分通过使用扩展获得——请参阅积分、里程碑与主题。

注意

请求会在 devsnip.apiTimeout(默认 30 秒)后超时。在客户端中为单个请求设置的超时会覆盖它,点击 Cancel 可提前停止请求。