0

0

如何用vscode进行API测试与调试_集成REST Client的实战方法【教程】

夢幻星辰

夢幻星辰

发布时间:2026-01-28 21:25:29

|

667人浏览过

|

来源于php中文网

原创

VS Code 通过 REST Client 扩展实现 API 测试:安装后新建 .http 文件,用 Ctrl+Alt+R 发送请求;支持请求头、JSON body、环境变量、响应变量提取等完整功能。

如何用vscode进行api测试与调试_集成rest client的实战方法【教程】

VS Code 本身不内置 API 测试功能,但通过 REST Client 扩展可直接在编辑器里发送 HTTP 请求、查看响应、管理环境变量——无需跳转 Postman 或命令行。

安装 REST Client 扩展并验证是否生效

打开 VS Code 扩展市场(Ctrl+Shift+X),搜索 REST Client,安装由 Huachao Mao 发布的官方扩展。安装后重启 VS Code(部分版本需重启才加载语法高亮)。新建一个文件,保存为 test.httpapi.test.http,输入以下内容:

GET https://www.php.cn/link/4d2fe2e8601f7a8018594d98f28706f2

光标停在该行,按 Ctrl+Alt+R(Windows/Linux)或 Cmd+Alt+R(Mac),若右下角弹出“Sending request…”并显示 JSON 响应,则扩展已正常工作。

常见问题:

  • 快捷键无效?检查是否与其他扩展冲突(如 Vim 插件会劫持 Ctrl+Alt+R),可在 keybindings.json 中重映射为 rest-client.request
  • 没有语法高亮?确认文件后缀是 .http.rest,且未被其他语言模式覆盖(右下角点击语言模式,手动选 HTTP

编写带请求头、参数和 body 的 HTTP 请求

REST Client 支持完整 HTTP 协议要素,但格式严格:空行分隔 headers 与 body,headers 每行一个,body 可为 raw、JSON、form-data 等。

示例(POST JSON):

POST https://httpbin.org/post
Content-Type: application/json

{ "name": "Alice", "age": 30 }

注意点:

  • 必须用空行分隔 headers 和 body;否则 body 被当作文本 header 处理,返回 400
  • JSON body 不需要引号包裹整个对象,也不支持 JS 注释(///* */ 会导致解析失败)
  • 查询参数可直接拼在 URL 后,如 GET https://www.php.cn/link/4d2fe2e8601f7a8018594d98f28706f2?foo=bar&baz=qux& 是 HTML 实体,实际写 & 即可,VS Code 会自动转义)

用 @variables 和 environments 管理多环境配置

避免硬编码 URL 或 token,用变量 + 环境切换实现测试/预发/生产一键切换。

在文件顶部定义变量块:

BibiGPT-哔哔终结者
BibiGPT-哔哔终结者

B站视频总结器-一键总结 音视频内容

下载
@host = https://www.php.cn/link/710ba53b0d353329706ee1bedf4b9b39
@token = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

GET {{host}}/users Authorization: Bearer {{token}}

更进一步,使用环境(environments):

### Environment: dev
@host = https://dev-api.example.com
@token = dev-token-123

Environment: prod

@host = https://www.php.cn/link/710ba53b0d353329706ee1bedf4b9b39 @token = prod-token-456

Get user list

GET {{host}}/users Authorization: Bearer {{token}}

点击右下角环境名称(默认 No Environment),选择 devprod,后续所有 {{host}}{{token}} 将自动替换为对应值。

关键细节:

  • 环境块之间必须用空行分隔,且每个环境块以 ### Environment: xxx 开头
  • 变量名不能含空格或特殊字符,仅限字母、数字、下划线
  • 环境变量只在当前文件内生效;跨文件复用需用 # @include 引入公共变量文件(需启用 rest-client.enableFileVariables 设置)

调试响应与链式请求(response variables)

从上一个响应中提取字段(如 token、ID),用于下一个请求——这是调试真实业务流的关键能力。

示例(登录后获取用户信息):

### Login
POST https://httpbin.org/post
Content-Type: application/json

{ "username": "test", "password": "123" }

{% client.global.set("auth_token", response.body.json().token); %}

Get profile

GET https://www.php.cn/link/4d2fe2e8601f7a8018594d98f28706f2 Authorization: Bearer {{auth_token}}

说明:

  • > {% ... %} 是响应脚本块,运行在 Node.js 环境中,response.body.json() 解析响应体为对象
  • client.global.set() 写入全局变量,跨请求可用;也可用 client.environment.set() 写入当前环境变量
  • 脚本中不能使用 console.log,错误会显示在输出面板(View → Output → REST Client)
  • 若响应非 JSON,用 response.body.toString() 或正则提取,例如 response.body.match(/"id":(\d+)/)[1]

真正难的是响应结构不稳定时的容错处理——比如字段可能不存在、嵌套层级变化、或返回 HTML 错误页而非 JSON。建议在脚本中加 if (response.body && response.headers['content-type']?.includes('json')) 判断,否则直接 return 避免 Cannot read property 'token' of undefined 报错。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

419

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

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

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

77

2025.09.10

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

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

439

2023.10.13

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

778

2023.08.22

登录token无效
登录token无效

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

6169

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

817

2023.09.14

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

158

2026.01.28

热门下载

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

精品课程

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

共48课时 | 8万人学习

Git 教程
Git 教程

共21课时 | 3.1万人学习

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

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