深入掌握VSCode REST客户端配置与使用

VSCode内置REST客户端无需插件即可调试API,通过.http文件发送GET、POST等请求,支持请求头、请求体配置,使用###分隔多请求,配合@variables和环境变量实现多环境切换,响应可保存并链式传递参数,提升开发效率。

深入掌握vscode rest客户端配置与使用

Visual Studio Code(VSCode)内置的REST客户端功能强大,无需额外安装插件即可发送HTTP请求,非常适合开发调试API接口。只需一个.http.rest文件,就能快速测试GET、POST、PUT、DELETE等请求,查看响应结果,甚至进行环境变量管理。下面详细介绍其配置与使用方法。

创建并运行REST请求

在VSCode中新建一个api.http文件,输入以下内容:

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

保存后,点击请求上方出现的Send Request按钮,右侧将弹出内联响应窗口,显示状态码、响应头和格式化后的JSON数据。

支持的HTTP方法包括:

  • GET:获取资源
  • POST:提交数据
  • PUT / PATCH:更新资源
  • DELETE:删除资源

每个请求之间用三个井号###分隔,便于组织多个测试用例。

设置请求头与请求体

发送POST请求时,需正确设置Content-Type并提供请求体:

POST https://jsonplaceholder.typicode.com/posts
Content-Type: application/json

{
  "title": "Hello VSCode",
  "body": "Using REST Client",
  "userId": 1
}

常见请求头可简写为缩写形式,如ct: application/json等同于Content-Type: application/json。VSCode会自动补全常用头字段,提升编写效率。

管理环境变量与多环境配置

通过@variables定义不同环境的变量,方便切换开发、测试、生产地址:

Vheer Vheer

AI图像处理平台

Vheer 260 查看详情 Vheer
@baseUrl = https://jsonplaceholder.typicode.com

GET {{baseUrl}}/posts/1
Accept: application/json

可在工作区根目录创建.vscode/settings.json文件,定义多环境变量:

{
  "rest-client.environmentVariables": {
    "dev": {
      "baseUrl": "http://localhost:3000"
    },
    "prod": {
      "baseUrl": "https://api.example.com"
    }
  }
}

编辑器右下角会出现环境选择器,点击即可切换当前激活的环境,所有{{baseUrl}}占位符会自动替换为对应值。

保存响应与后续处理

响应面板支持查看Raw数据、Pretty格式化、Preview(如HTML)、Timeline等选项。可右键保存响应体到本地文件,用于比对或归档。

还可利用响应中的值进行链式调用:

POST https://jsonplaceholder.typicode.com/posts
Content-Type: application/json

{
  "title": "First Post",
  "userId": 1
}

> {%
   client.global.set("postId", response.body.id);
%}

之后的请求可使用{{postId}}引用该ID,实现跨请求参数传递。

基本上就这些。VSCode REST客户端简洁高效,适合日常接口调试,配合变量、环境管理和脚本能力,足以替代部分Postman场景。不复杂但容易忽略细节,掌握后能显著提升开发效率。

以上就是深入掌握VSCode REST客户端配置与使用的详细内容,更多请关注其它相关文章!

本文转自网络,如有侵权请联系客服删除。