跳转到主内容
新派编程网 - 新潮编程理念,全新技术课堂!

如何使用VSCode进行REST API的测试与调试【教程】

VSCode通过REST Client扩展支持内置HTTP请求调试。安装后新建.http文件,用Ctrl+Alt+R发送GET/POST请求,支持变量、环境配置和响应格式化,但不支持WebSocket、自动重定向或登录态维持。 VSCode 本身不内置 REST 客户端,但通过
REST Client
扩展可直接在编辑器里发请求、看响应、管理环境变量——比切到 Postman 更轻量,尤其适合前后端联调或快速验证接口。 安装并启用 REST Client 扩展 在 VSCode 扩展市场搜索
REST Client
(作者是 Huachao Mao),安装后无需重启,新建一个以
.http
或
.rest
为后缀的文件即可开始写请求。 扩展不依赖 Node. js 运行时,纯客户端执行,无后台服务开销 不支持 WebSocket 或流式响应(如 SSE),遇到
Connection: keep-alive
长连接会自动关闭 若已装了类似
Thunder Client
,两者功能重叠,建议只留一个避免快捷键冲突 编写和发送最简 HTTP 请求 在
example.http
中写:
GET https://httpbin.org/get User-Agent: vscode-restclient
光标停在任意请求块内,按
Ctrl+Alt+R
(Windows/Linux)或
Cmd+Alt+R
(macOS),右侧将弹出响应面板。 请求体支持
GET
带
?key=value
,也支持
POST
+
JSON
:在空行后写 JSON,前面加
Content-Type: application/json
响应体默认显示原始文本;若含
Content-Type: application/json
,会自动格式化并高亮 响应头里的
Set-Cookie
不会自动带入后续请求,需手动用
@cookies
变量捕获 用变量管理不同环境(dev/staging/prod) 在文件顶部定义变量块: ChatGPT (Windows) ChatGPT Windows 版本优化了系统兼容性与响应速度,提供多任务处理和对话记录管理功能,适用于办公辅助、创意写作、学习辅导和日常问答。它能帮助用户快速生成文稿、整理资料和高效获取信息,为个人和团队提供稳定、流畅的生产力体验。 下载
@host = https://api.dev.example.com @auth = Bearer abc123 GET {{host}}/users Authorization: {{auth}}
变量名用双大括号引用,支持嵌套和简单字符串拼接(如
{{host}}/v1{{path}}
)。 变量作用域限于当前文件;跨文件复用需用全局配置
rest-client.environmentVariables
写进
settings.json
敏感值(如 token)别硬编码,改用 VSCode 的
env
变量:
@token = {{env:API_TOKEN}}
,再在终端里
export API_TOKEN=xxx
变量不支持运行时计算(比如不能写
@now = {{timestamp()}}
),时间戳得手动生成 调试常见失败原因 请求卡住、返回 401 或 502,先检查这几处:
401 Unauthorized
:确认
Authorization
头拼写正确(注意大小写),Token 是否过期;
Bearer
和 token 之间必须有空格 响应空白或超时:检查 URL 是否含中文或特殊字符未编码;
https://
错写成
http://
且服务端强制跳转时,REST Client 不跟随重定向 JSON 解析失败:响应实际是 HTML(如 Nginx 502 页面)却声明了
application/json
,此时格式化会报错,需点「Raw」看真实内容 代理失效:VSCode 设置里
http.proxy
生效,但若公司用 PAC 脚本,REST Client 不支持,得关掉代理或配系统级代理 真正麻烦的是需要登录态维持、CSRF Token 动态提取、或 OAuth 三步跳转的场景——这些得靠外部脚本预处理,REST Client 本身不提供钩子。

相关文章