如何使用VSCode的REST Client插件测试API接口?

37次阅读

使用 vscode 的 REST Client 插件可直接在编辑器内测试 API,安装后创建 .http 文件,编写请求并点击 Send Request 即可查看响应,支持多请求分隔与环境变量管理,提升调试效率。

如何使用VSCode的REST Client插件测试API接口?

使用 VSCode 的 REST Client 插件可以轻松测试 API 接口,无需离开编辑器就能发送 HTTP 请求并查看响应。操作简单直观,适合前后端开发调试。

安装 REST Client 插件

打开 VSCode,进入扩展市场(快捷键 Ctrl+Shift+X),搜索 REST Client,选择由 Huachao Mao 开发的插件并安装。

创建请求文件

新建一个以 .http.rest 为后缀的文件,例如 api.test.http。在这个文件中编写你的 API 请求。

基本语法如下:

  • 指定请求方法(GET、POST、PUT、delete 等)
  • 写上完整的 URL
  • 添加请求头(可选)
  • 空一行后写请求体(仅 POST/PUT 等需要)

示例:

GET https://www.php.cn/link/a6bebbe36e02bb16c654383299bc7740/1 <h3></h3><p>POST <a href="https://www.php.cn/link/a6bebbe36e02bb16c654383299bc7740">https://www.php.cn/link/a6bebbe36e02bb16c654383299bc7740</a> Content-Type: application/json</p><p>{ "title": "测试文章", "body": "这是内容", "userId": 1 }

发送请求并查看响应

在写好的请求下方,会显示一个 Send Request 的蓝色链接。点击它,VSCode 会在右侧新标签页中显示服务器返回的响应内容,包括状态码、响应头和响应体。

你可以同时在一个文件中写多个请求,用 ### 分隔,方便组织不同接口的测试用例。

如何使用VSCode的REST Client插件测试API接口?

SpeakingPass-打造你的专属雅思口语语料

使用chatGPT帮你快速备考雅思口语,提升分数

如何使用VSCode的REST Client插件测试API接口? 25

查看详情 如何使用VSCode的REST Client插件测试API接口?

保存常用环境变量(进阶用法)

如果接口地址在不同环境(如开发、测试、生产)之间切换,可以用变量简化管理。

在项目根目录创建 rest-client.environment.json 文件:

{   "dev": {     "apiUrl": "https://dev.api.com"   },   "prod": {     "apiUrl": "https://api.com"   } }

然后在 .http 文件中使用:

GET {{apiUrl}}/users

通过右下角状态栏切换当前环境,变量会自动替换。

基本上就这些。写好请求、点一下、看结果,整个过程流畅高效,特别适合快速验证接口行为。

text=ZqhQzanResources