0

0

怎样在vscode中编写GraphQL查询与API测试【教程】

夜晨

夜晨

发布时间:2026-01-16 23:12:59

|

564人浏览过

|

来源于php中文网

原创

VS Code 通过 GraphQL 官方插件(提供语法高亮与基于 schema 的智能补全)和 GraphQL Request 插件(支持在 .graphql 文件中用注释声明 endpoint 并快捷发送请求)实现本地 GraphQL 测试流,需正确配置 schema 路径或地址、严格遵循 variables JSON 格式,并借助 Output 面板、curl 和服务端日志定位请求失败原因。

怎样在vscode中编写graphql查询与api测试【教程】

VS Code 本身不内置 GraphQL 查询执行能力,但通过合理组合插件和配置,可以实现「编写 → 校验 → 发送 → 查看响应」的完整本地测试流。关键不在“装什么”,而在“怎么连通”。

GraphQL 查询语法高亮与自动补全靠什么?

核心依赖 GraphQL 官方插件(GraphQL.vscode-graphql),但它必须配合 schema 才能启用智能提示。没有 schema,它只做基础语法着色。

  • 必须在项目根目录或工作区配置 .graphqlrcgraphql.config.js,指向有效的 schema(本地文件、HTTP endpoint 或 introspection JSON)
  • 推荐初学者用 schema: "http://localhost:4000/graphql" 直连本地开发服务(需服务已启动且允许 CORS)
  • 若用 schema: "./schema.graphql",确保该文件是合法 SDL 格式(不是 JSON),且路径正确——常见错误是路径写错或文件内容为 introspection 结果 JSON

如何不离开 VS Code 就发送 GraphQL 请求?

GraphQL Request 插件(jimmydief.vscode-graphql-request),它复用 VS Code 内置的 fetch 能力,无需额外服务进程。

  • 查询必须写在 .graphql 文件中,且顶部加注释声明 endpoint:
    # GraphQL Request: http://localhost:4000/graphql
    query GetUser {
      user(id: "1") {
        name
        email
      }
    }
  • 光标放在 query 内,按 Ctrl+Alt+R(Windows/Linux)或 Cmd+Alt+RmacOS)触发请求
  • 响应默认显示在右侧面板;如无响应,请检查终端是否报错 NetworkError when attempting to fetch resource——大概率是 endpoint 地址错、服务未运行,或服务返回了非 2xx 状态码(如 400 带 GraphQL 错误)

为什么 mutation 总是报错“Variable $input is not defined”?

这是变量声明与使用不匹配的典型表现,GraphQL Request 插件要求显式声明变量块,且格式严格。

站酷梦笔
站酷梦笔

国内知名设计社区站酷推出的AI插画生成工具

下载
  • 必须在 query 下方紧接 variables 注释块,用 JSON 格式,不能有 trailing comma,不能用单引号:
    # GraphQL Request: http://localhost:4000/graphql
    mutation CreateUser($input: CreateUserInput!) {
      createUser(input: $input) {
        id
        name
      }
    }
    # variables
    {
      "input": {
        "name": "Alice",
        "email": "alice@example.com"
      }
    }
  • 变量名($input)必须与 variables 块中的 key 完全一致,大小写敏感
  • 如果 schema 要求非空(!),而 variables 中对应字段为 null 或缺失,也会报错——此时应删掉该字段或填有效值

调试失败请求时最该看哪三处?

别急着改 query,先确认链路底层是否通畅。

  • 打开 VS Code 的 Output 面板(Ctrl+Shift+U),选择 GraphQL Request 输出通道,看原始 request URL、headers 和 error 堆
  • curl 手动复现:把 Output 里打印出的 URL 和 JSON body 拷出来,执行 curl -X POST -H "Content-Type: application/json" -d '{"query":"...","variables":{...}}' http://localhost:4000/graphql,排除插件封装干扰
  • 检查服务端日志:很多 GraphQL 错误(如 resolver 抛异常)只打在服务端 console,VS Code 插件只收到一个模糊的 500 响应

真正卡住的往往不是语法,而是 schema 加载失败、endpoint 不可达、或 variables 结构与 schema 类型定义不匹配——这些在插件 UI 上几乎不提示,得翻 Output 面板和终端日志。

相关专题

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

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

411

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的详细内容,可以访问本专题下面的文章。

309

2023.10.13

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

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

74

2025.09.10

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

231

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

436

2024.03.01

resource是什么文件
resource是什么文件

Resource文件是一种特殊类型的文件,它通常用于存储应用程序或操作系统中的各种资源信息。它们在应用程序开发中起着关键作用,并在跨平台开发和国际化方面提供支持。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

149

2023.12.20

curl_exec
curl_exec

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

425

2023.06.14

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.16

热门下载

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

精品课程

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

共48课时 | 7.2万人学习

Git 教程
Git 教程

共21课时 | 2.7万人学习

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

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