VS Code 的 REST Client 插件支持在编辑器内直接发送 HTTP 请求并查看响应。安装后创建。http 文件,用 GET、POST 等方法调试接口,支持环境变量、多请求分隔与 JSON 格式化响应。

在开发过程中,调试 API 接口是必不可少的一环。使用 VS Code 的 REST Client 插件,你可以直接在编辑器中发送 HTTP 请求并查看响应结果,无需切换到外部 工具 如 Postman。操作简单直观,适合前 后端 联调或测试第三方接口。
安装 REST Client 插件
打开 VS Code,进入扩展商店(快捷键 Ctrl+Shift+X),搜索 REST Client,选择由 Humao 开发的版本并安装。
安装完成后,你就可以创建一个以 .http 或 .rest 为后缀的文件来编写请求了。
编写和发送请求
新建一个 api.test 文件,输入以下内容:
GET https://jsonplaceholder.typicode.com/posts/1
将光标放在该请求行上,点击出现的 Send Request 链接,插件会立即发送请求,并在右侧新标签页中展示响应结果,包括 状态码、响应头和格式化后的 JSON 数据。
支持的请求方法包括:
- GET – 获取资源
- POST – 提交数据
- PUT / PATCH – 更新资源
- DELETE – 删除资源
例如,发送一个带 JSON 体的 POST 请求:
POST https://jsonplaceholder.typicode.com/posts Content-Type: application/json <p>{"title": "Hello VS Code", "body": "Using REST Client to test", "userId": 1}
管理请求与 环境变量
对于不同环境(如开发、测试、生产),可以使用变量来避免硬 编码URL。
在项目根目录创建 rest-client.environment.json 文件:
{"dev": { "api_url": "https://dev.api.com", "token": "dev_123"}, "prod": {"api_url": "https://api.com", "token": "prod_xyz"} }
然后在请求中使用变量:
GET {{api_url}}/users Authorization: Bearer {{token}}
发送请求前,点击右下角环境切换按钮选择当前使用的配置(如 dev),变量会自动替换。
保存常用请求与组织文件
你可以将多个请求写在一个 .http 文件中,用 ### 分隔,方便归类。
### 获取用户列表 GET https://www.php.cn/link/93a819cbd635bd1505ef0f804c21cc2a <h3> 创建新用户 </h3><p>POST <a href="https://www.php.cn/link/93a819cbd635bd1505ef0f804c21cc2a">https://www.php.cn/link/93a819cbd635bd1505ef0f804c21cc2a</a> Content-Type: application/json</p><p>{"name": "Alice", "email": "alice@example.com"}
每个请求块之间用 ### 分隔,清晰易读,适合团队共享调试文件。
基本上就这些。REST Client 让你在编码时顺手测试接口,提升效率,减少上下文切换。不复杂但容易忽略。
以上就是使用 REST Client 插件在 VS Code 中调试 API 接口的详细内容,更多请关注 php 中文网其它相关文章!