在VSCode中使用REST Client插件测试API接口

VSCode中需安装REST Client插件（作者Huachao Mao）以发送HTTP请求；创建.api-test.http文件编写标准请求；点击“Send Request”查看响应；支持环境变量（.rest-client文件定义）和调试（cURL验证、debug日志）。

如果您在VSCode中编写HTTP请求但无法直接发送并查看响应，可能是由于缺少专用的HTTP测试工具。REST Client插件提供了一种轻量、内联、无需切换窗口即可发起请求的方式。以下是使用该插件完成API接口测试的具体操作步骤：

本文运行环境：MacBook Air，macOS Sequoia。

一、安装REST Client插件

REST Client插件必须先安装到VSCode中，才能识别并执行以.http或.rest为扩展名的文件中的请求语句。该插件由Huachao Mao开发，支持语法高亮、自动补全、环境变量及响应预览等功能。

1、打开VSCode，点击左侧活动栏的扩展图标（四个方块组成的图标）。

2、在扩展搜索框中输入REST Client。

3、在搜索结果中找到作者为Huachao Mao的官方插件，点击“安装”按钮。

4、安装完成后，重启VSCode以确保插件完全加载。

二、创建并编写HTTP请求文件

REST Client通过解析纯文本HTTP请求语法来构造并发送请求，因此需新建一个符合规范的请求文件，并正确书写请求行、头部与可选正文。

1、在VSCode资源管理器中右键项目文件夹，选择“新建文件”。

2、将文件命名为api-test.http（扩展名必须为.http或.rest）。

3、在文件中输入标准HTTP请求格式，例如：
GET https://httpbin.org/get
User-Agent: REST-Client

4、保存文件，此时编辑器顶部会出现“Send Request”链接。

三、发送请求并查看响应

点击“Send Request”链接后，REST Client会在内置响应面板中展示服务器返回的原始响应内容，包括状态码、响应头和响应体，便于快速验证接口行为。

1、将光标置于请求语句任意位置（如GET行），或确保整个请求块被选中。

度加剪辑

度加剪辑（原度咔剪辑），百度旗下AI创作工具

380

查看详情

2、点击编辑器上方出现的Send Request链接。

3、右侧会自动弹出响应标签页，显示200 OK及完整的响应头与JSON正文。

4、响应区域支持滚动、复制全部、保存响应到文件等操作。

四、使用环境变量管理多套配置

在不同环境（如开发、测试、生产）下测试同一接口时，硬编码URL和参数会降低可维护性。REST Client支持定义环境变量，在请求中通过{{variable}}语法引用，实现配置复用。

1、在工作区根目录创建文件.rest-client（无扩展名）。

2、在该文件中按环境分组定义变量，例如：
@host = https://api.dev.example.com
@authToken = abc123

3、在.api-test.http中编写请求时引用：
GET {{host}}/users
Authorization: Bearer {{authToken}}

4、通过命令面板（Cmd+Shift+P）执行“REST Client: Switch Environment”，选择对应环境即可动态切换。

五、调试请求失败问题

当请求返回非预期状态码（如400、401、500）或超时，需检查请求结构、认证信息及网络连通性。REST Client提供详细的错误提示和原始请求日志，有助于定位根本原因。

1、观察响应面板顶部显示的Request failed with status code 401等明确错误信息。

2、检查请求头中是否遗漏Content-Type或Authorization字段。

3、右键响应区域，选择“Copy Request As cURL”，在终端中粘贴执行，验证是否为VSCode代理或插件限制导致的问题。

4、启用详细日志：在VSCode设置中搜索“rest-client.loggingLevel”，设为“debug”，然后查看输出面板中的“REST Client”通道日志。

以上就是在VSCode中使用REST Client插件测试API接口的详细内容，更多请关注php中文网其它相关文章！