VSCode的REST Book：像写代码一样管理API请求

vscode的REST Client插件支持通过.rest文件以类http语法定义、分组与执行API请求，含环境变量、响应查看等功能。

如果您希望在开发过程中高效组织和复用API请求，VSCode的REST Book插件提供了一种类代码的文本化方式来定义、分组与执行HTTP请求。以下是使用该插件实现API请求管理的具体操作路径：

本文运行环境：macBook air，macOS Sequoia。

一、安装REST Client插件

REST Book功能由广为使用的REST Client扩展提供支持，需先在VSCode中启用该扩展以解锁请求文件解析与发送能力。

1、打开VSCode，点击左侧活动栏中的扩展图标（或按快捷键Ctrl+Shift+X）。

2、在搜索框中输入REST Client，找到作者Huachao Mao发布的官方扩展。

3、点击“安装”按钮，等待安装完成并重启VSCode（如提示）。

二、创建.rest请求文件

REST Client通过识别以.rest为后缀的纯文本文件来加载请求定义，文件内容遵循类HTTP语法，便于版本控制与协作。

1、在工作区中右键新建文件，命名为api.test.rest。

2、确保文件编码为UTF-8，且无bom头。

3、在文件顶部添加注释行，例如：### GET User List，用于标识请求区块。

三、编写结构化请求语句

每个请求区块以HTTP方法开头，后接URL、可选请求头及空行分隔的请求体，支持变量、环境配置与多行注释。

1、在.rest文件中输入以下内容：

GET https://jsonplaceholder.typicode.com/posts/1

User-Agent: REST-Client-Example

Accept: application/json

2、空一行后，可追加jsON请求体（仅适用于POST/PUT等）：

POST https://jsonplaceholder.typicode.com/posts

Content-Type: application/json

{

“title”: “My Post”,

“body”: “Hello REST”,

“userId”: 1

}

四、使用环境变量隔离测试配置

通过定义环境配置块，可在不同部署场景下切换基础URL、认证令牌等参数，避免硬编码。

1、在.rest文件顶部添加环境定义段落，以@开头：

@baseUrl = https://jsonplaceholder.typicode.com

@authToken = Bearer abc123xyz

2、在后续请求中引用变量，例如：GET {{baseUrl}}/users/1。

3、点击右上角“switch Environment”选择预设环境，或直接编辑变量值。

五、执行与查看响应结果

REST Client将请求发送至目标服务，并在内置响应面板中展示状态码、响应头与格式化后的响应体，支持JSON高亮与折叠。

1、将光标置于任意请求区块内（含方法行与URL行）。

2、按下快捷键Cmd+Alt+R（macos）或右键选择“Send Request”。

3、响应结果自动在新标签页中展开，标题显示Response – [Status Code]。