VS Code 通过 REST Client 扩展支持轻量级 REST API 测试,无需启动服务,纯客户端解析 .http 文件;需安装扩展、配置环境变量文件、规范编写请求块,并注意响应大小与类型限制。

VS Code 本身不内置 REST API 测试功能,但通过 REST Client 扩展可直接在编辑器里发请求、看响应、管理环境变量——比切到 Postman 更轻量,尤其适合前后端联调或快速验证接口。
安装并启用 REST Client 扩展
在 VS Code 扩展市场搜 REST Client(作者是 Huachao Mao),安装后重启(部分版本需重启才生效)。它不依赖任何运行时,也不需要启动服务,纯客户端解析 .http 文件。
- 确认已禁用可能冲突的扩展,比如某些 HTTP 请求插件或旧版替代品
- 扩展启用后,新建文件保存为
test.http,VS Code 会自动识别语法高亮和发送按钮 - 若点击“Send Request”无反应,检查右下角状态栏是否显示
REST Client,没显示说明未激活或文件未被识别
写一个合法的 .http 请求文件
REST Client 要求请求块之间用空行分隔,每块以方法名开头,支持 GET、POST、PUT、DELETE 等。URL 必须完整(含协议),Header 每行一个,Body 放在最后(若存在)。
GET https://jsonplaceholder.typicode.com/posts/1
User-Agent: vscode-restclient
Accept: application/json
POST https://httpbin.org/post
Content-Type: application/json
{
"name": "Alice",
"age": 30
}
- URL 不能缩写成
/api/users,必须带https://或http:// - Header 行末不能有多余空格,否则可能被忽略;
Content-Type缺失时,POST默认不带 body - Body 是 JSON 时建议加
Content-Type: application/json,否则服务端可能解析失败
用 {{variable}} 管理多环境 URL 和 Token
把易变值(如 base URL、auth token)抽成变量,定义在单独的 rest-client.environment.json 文件中,再在 .http 里用 {{baseUrl}} 引用。VS Code 右上角可切换环境(如 dev / staging / prod)。
示例配置文件:rest-client.environment.json
{
"dev": {
"baseUrl": "https://api.dev.example.com",
"token": "dev-abc123"
},
"prod": {
"baseUrl": "https://api.example.com",
"token": "prod-xyz789"
}
}
- 变量名不能含短横线(
-)或空格,推荐用小驼峰或下划线 - 环境文件必须放在工作区根目录,且文件名严格为
rest-client.environment.json - 变量只在当前工作区生效,跨文件夹打开需重新配置
响应体过大或二进制内容怎么处理
默认情况下,REST Client 会尝试将响应按 UTF-8 解析并显示为文本。遇到 PDF、图片或超大 JSON 时,会卡顿或报错 Response is too large to display。
- 响应超过 1MB 时,它会自动截断,不会崩溃,但你无法看到完整 body
- 对非文本响应(如
image/png),它仍会尝试转字符串,结果是乱码;此时应改用curl或浏览器调试 - 临时解决大响应:在请求头加
Accept: text/plain(如果服务端支持),或用HEAD先查状态码和 headers
真正复杂的场景(如鉴权链路、multipart 表单、流式响应),还是得靠专门工具。REST Client 的优势在于“够用、顺手、不跳出编辑器”,别硬扛它不擅长的事。










