0

0

怎样使用VSCode进行REST API测试?_无需离开编辑器的调试【教程】

狼影

狼影

发布时间:2026-01-20 23:14:01

|

568人浏览过

|

来源于php中文网

原创

VSCode需安装REST Client扩展才能发送HTTP请求;保存为.http文件、设语言模式为HTTP后,可用快捷键或按钮发送GET/POST请求,并通过环境变量管理多环境API地址。

怎样使用vscode进行rest api测试?_无需离开编辑器的调试【教程】

VSCode 本身不内置 REST 客户端,但通过 REST Client 扩展可直接在编辑器内发送 HTTP 请求、查看响应、管理环境变量——无需切换 Postman 或 curl 命令行。

安装并启用 REST Client 扩展

在 VSCode 扩展市场搜索 REST Client(作者:Huachao Mao),点击安装并重载窗口。安装后,VSCode 会自动识别以 .http.rest 为后缀的文件,并提供语法高亮与发送按钮。

常见错误现象:Send Request 按钮不出现,或点击无响应——通常因文件未保存(必须先保存为 .http)、或当前语言模式未设为 HTTP(右下角点击语言模式,手动选 HTTP)。

编写并运行一个基础 GET 请求

新建文件,保存为 test.http,输入以下内容:

GET https://jsonplaceholder.typicode.com/posts/1
User-Agent: VSCode-REST-Client

将光标置于该请求块内(任意位置),按 Ctrl+Alt+R(Windows/Linux)或 Cmd+Alt+RmacOS),或点击右上角 Send Request 链接。响应会直接在新标签页中显示,含状态码、头信息与响应体。

注意点:

  • GET 后必须跟完整 URL(支持变量,见下一条)
  • 空行分隔请求头与请求体(POST/PUT 时需用)
  • 不支持自动重定向(302 等会原样返回,不会跳转)

使用环境变量管理不同 API 地址

在工作区根目录创建 .vscode/settings.json,添加:

Veggie AI
Veggie AI

Veggie AI 是一款利用AI技术生成可控视频的在线工具

下载
"rest-client.environmentVariables": {
  "local": {
    "host": "http://localhost:3000"
  },
  "prod": {
    "host": "https://api.example.com"
  }
}

再新建 env.http,写入:

@host = {{host}}

GET {{host}}/users
Accept: application/json

点击右下角环境选择器(默认显示 local),切换即可复用同一请求适配多环境。变量名如 {{host}} 必须在 @ 声明之后才可用,且不能跨文件共享。

容易踩的坑:

  • 变量名拼写错误(如 {{hosst}})会导致 URL 解析失败,报错 Invalid URI
  • 环境变量值末尾带斜杠("host": "http://localhost:3000/")会导致双斜杠 //,部分服务拒绝解析

发送 POST 请求并携带 JSON Body

确保请求头明确指定 Content-Type,并在空行后写入 JSON:

POST {{host}}/login
Content-Type: application/json

{
  "username": "alice",
  "password": "secret123"
}

注意:

  • Body 必须是合法 JSON(键名加引号,无尾逗号),否则报错 Unexpected token
  • 若需动态值(如时间戳),可用 {{timestamp}} 变量,但需配合插件脚本或外部工具生成——REST Client 原生不支持函数式变量(如 {{now()}}
  • 二进制文件上传不可用;表单提交需手动构造 multipart/form-data,极不推荐——此时应换用 curl 或 Postman

真正卡住人的往往不是语法,而是环境变量作用域、URL 拼接逻辑和 Content-Type 是否匹配实际 payload。建议每个项目单独建 .http 文件,按功能分组,避免混用全局变量。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

413

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

75

2025.09.10

软件测试常用工具
软件测试常用工具

软件测试常用工具有Selenium、JUnit、Appium、JMeter、LoadRunner、Postman、TestNG、LoadUI、SoapUI、Cucumber和Robot Framework等等。测试人员可以根据具体的测试需求和技术栈选择适合的工具,提高测试效率和准确性 。

436

2023.10.13

curl_exec
curl_exec

curl_exec函数是PHP cURL函数列表中的一种,它的功能是执行一个cURL会话。给大家总结了一下php curl_exec函数的一些用法实例,这个函数应该在初始化一个cURL会话并且全部的选项都被设置后被调用。他的返回值成功时返回TRUE, 或者在失败时返回FALSE。

431

2023.06.14

linux常见下载安装工具
linux常见下载安装工具

linux常见下载安装工具有APT、YUM、DNF、Snapcraft、Flatpak、AppImage、Wget、Curl等。想了解更多linux常见下载安装工具相关内容,可以阅读本专题下面的文章。

175

2023.10.30

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6099

2023.09.14

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

19

2026.01.20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 7.5万人学习

Git 教程
Git 教程

共21课时 | 2.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号