如何在 VS Code 中测试 REST API
本页内容 7 个小节
简短回答:安装一个 REST 客户端扩展,在代码旁边打开它,然后从那里发送请求。本指南使用 DevSnip Pro 中免费的 REST API 客户端:无需账号,支持环境、集合、cURL 导入和代码生成。文中介绍的习惯适用于任何客户端。

在编辑器和单独的 API 工具之间来回切换,代价比看起来要大:从代码中复制 URL,从 . 文件中粘贴令牌,发送,然后再把 JSON 复制回来写类型或测试。在 VS Code 中,代码、请求和响应都挨在一起。
- 在命令面板(Ctrl/Cmd+Shift+P)中运行 DevSnip Pro: REST API Client,或在 DevSnip Pro 侧边栏中点击它。
- 点击 Send a sample request。它会发送
GET https:/,这是一个免费的公共测试 API。/ jsonplaceholder. typicode. com/ todos/ 1 - 响应面板会显示状态码、耗时和大小,可搜索的格式化 JSON,以及响应头和 Cookie。
对于你自己的 API,输入 URL 并按 Enter。如果你已经有该请求的 cURL 命令(浏览器开发者工具中的 Copy as cURL),把它粘贴到 URL 栏:方法、请求头和请求体都会被导入。
为每个目标创建一个环境,例如 local 和 staging,并设置 baseUrl、token 等变量。然后这样编写请求:
GET {{baseUrl}}/users/42
Authorization: Bearer {{token}}切换环境即可对另一台服务器重新运行同一个请求,而且保存的请求中不会包含密钥。
把请求保存到集合中,并按与 API 结构对应的文件夹分组(auth/、users/、billing/)。历史记录会保存你发送过的所有内容,看起来像凭据的 URL 值会被隐藏。保存的请求会成为项目中下一位成员的活文档。
返回 200 但响应体不对,依然是 bug。对于你修改的每个端点,请检查:
- 结构:字段是否存在、类型是否符合预期、命名是否一致?
- 错误输入:缺少必填字段或字段类型错误时,应返回清晰的
4xx,而不是带堆栈信息的500。 - 认证:令牌过期或缺失。JWT Decoder & Signer 可以签发一个
exp已过期的测试令牌。 - 资源不存在:返回带有用信息的
404。 - 响应头:
Content-Type、缓存相关响应头,以及当浏览器会调用它时的 CORS 响应头(CORS Builder & Debugger 会解释 CORS 错误)。 - 耗时:在本地需要 900 毫秒的端点,到了生产环境也不会更快。
当你第三次检查同一个字段时,就把它变成每次发送都会运行的断言,串联请求(登录 → 创建 → 验证),或者运行批量测试查看延迟百分位数。这些高级工具使用通过使用扩展获得的积分支付;无需购买任何东西。
请求跑通后,为它生成代码:JavaScript(fetch 或 Axios)、Python、Go、Java 或 C#,或者导出为 cURL,用于 README 或问题报告。要从响应生成类型,请在工具侧边栏中打开 JSON to Types:TypeScript、Zod、Pydantic、Kotlin、Swift、Dart、Java、Go 或 JSON Schema。
基于规范开发?OpenAPI / Swagger Toolkit 可以检查规范、列出所有端点,并生成 TypeScript 类型、fetch 客户端和 cURL 命令。
- 打开数据库客户端,确认请求写入的数据行。请参阅如何在 VS Code 中连接 PostgreSQL、MySQL、MongoDB 和 Redis。
- 对你有权测试的 URL 运行 DevSnip Pro: Endpoint Security Scan:TLS、HSTS、安全响应头、CSP、CORS 和 Cookie,每项都附有修复方法。请参阅如何在 VS Code 中查找硬编码的密钥与安全问题。
| 步骤 | 为什么重要 |
|---|---|
| 环境 | 一个请求,多台服务器;保存的请求中没有密钥 |
| 集合 | 可重复的检查和共享的知识 |
| 异常路径 | 发现接口约定和错误处理方面的 bug |
| 代码与类型 | 无需手动复制 URL 和 JSON |
| 安全扫描 | 发布前修复配置错误的响应头成本很低 |