VSCode REST API测试与HTTP客户端配置指南-VSCode-PHP中文网

VSCode REST API测试与HTTP客户端配置指南

夜晨

发布： 2025-11-13 21:35:03

原创

550人浏览过

VSCode通过内置.http文件支持高效测试REST API，创建api-test.http文件即可编写请求，如GET https://jsonplaceholder.typicode.com/posts/1并发送查看响应；利用rest-client.environmentVariables配置全局与环境变量，实现多环境切换；支持POST等带body请求，需设置Content-Type并空行后写入数据；自动管理Cookie会话，并可通过响应提取变量如token供后续请求使用，提升调试效率。

vscode rest api测试与http客户端配置指南

在开发过程中，测试 REST API 是一项高频任务。VSCode 通过内置的 .http 文件支持，提供了轻量高效的 HTTP 客户端功能，无需切换工具即可发送请求、查看响应并管理会话状态。

启用与创建 HTTP 请求文件

VSCode 原生支持以 .http 为扩展名的文件来编写和执行 HTTP 请求。只需新建一个文件，命名为如 api-test.http，VSCode 会自动识别语法并提供运行按钮。

在文件中输入以下格式的请求：

指定请求方法（GET、POST 等）
填写完整 URL
添加必要的请求头
如有需要，写入请求体

示例：

GET https://jsonplaceholder.typicode.com/posts/1
Accept: application/json

登录后复制

将光标置于请求上方，点击出现的 Send Request 链接，即可在右侧新标签页中查看响应内容。

设置全局与环境变量

为避免硬编码 URL 或认证信息，可使用变量提升可维护性。VSCode 支持通过 rest-client.environmentVariables 配置不同环境的变量。

打开 VSCode 设置（settings.json），添加如下配置：

"rest-client.environmentVariables": {
  "$shared": {
    "api_url": "https://api.example.com"
  },
  "dev": {
    "host": "{{api_url}}/v1",
    "token": "dev-abc123"
  },
  "prod": {
    "host": "{{api_url}}/v1",
    "token": "prod-xyz987"
  }
}

登录后复制

在 .http 文件中引用变量：

GET {{host}}/users
Authorization: Bearer {{token}}

登录后复制

通过右下角环境选择器切换 dev 或 prod，实现多环境快速测试。

发送带 body 的请求（如 POST/PUT）

对于需要提交数据的请求，确保正确设置 Content-Type 并格式化请求体。

白瓜面试

白瓜面试 - AI面试助手,辅助笔试面试神器

查看详情

使用 Content-Type: application/json
空行后写入 JSON 数据

示例：

POST {{host}}/users
Content-Type: application/json
<p>{
"name": "Alice",
"email": "alice@example.com"
}</p>

登录后复制

注意：请求头与 body 之间必须有一个空行，否则会导致解析失败。

处理身份认证与 Cookie 会话

某些接口需要登录或维持会话。VSCode 的 HTTP 客户端支持自动管理 Cookie。

若服务端返回 Set-Cookie，后续请求会自动携带该 Cookie（同域名下），适用于基于 session 的认证流程。

对于 Token 认证，推荐将 token 存入环境变量：

Authorization: Bearer {{token}}

登录后复制

也可结合临时变量，在响应中提取值供后续请求使用：

# 登录获取 token
POST {{host}}/auth/login
Content-Type: application/json
<p>{
"username": "test",
"password": "123456"
}</p><h3>Extract token from response</h3><p>@token = {{login.response.body.token}}</p><h1>使用提取的 token</h1><p>GET {{host}}/profile
Authorization: Bearer {{token}}</p>

登录后复制

基本上就这些。VSCode 的 HTTP 客户端虽不如 Postman 功能全面，但足够应对日常开发中的接口测试需求，且集成度高、启动快、无需额外安装软件。合理使用变量和环境配置，能显著提升调试效率。

以上就是VSCode REST API测试与HTTP客户端配置指南的详细内容，更多请关注php中文网其它相关文章！