0

0

VSCode for GraphQL:API查询语言的完整支持

P粉986688829

P粉986688829

发布时间:2026-01-08 18:34:02

|

416人浏览过

|

来源于php中文网

原创

需安装GraphQL扩展、配置Schema路径、设置文件关联并集成Apollo工具链。具体包括:安装Prisma发布的GraphQL for VSCode扩展;创建.graphqlrc.yml指定schema位置;在settings.json中关联.graphql/.gql文件;对JS/TS中的gql模板添加注释标记;安装Apollo CLI及Apollo GraphQL扩展以支持查询执行与验证。

vscode for graphql:api查询语言的完整支持

如果您在使用 VSCode 编辑 GraphQL 代码时遇到语法高亮缺失、自动补全失效或 Schema 验证失败等问题,则可能是由于缺少对应的语言支持与扩展配置。以下是实现完整 GraphQL 支持的具体操作:

本文运行环境:MacBook Air,macOS Sequoia。

一、安装 GraphQL 官方语言支持扩展

VSCode 默认不内置 GraphQL 语言服务,需通过官方维护的扩展启用语法识别、文档悬停与错误提示功能。

1、打开 VSCode,点击左侧活动栏的扩展图标(或按 Cmd+Shift+X)。

2、在搜索框中输入 GraphQL for VSCode,选择由 Prisma 团队发布的官方扩展(作者显示为 Prisma)。

3、点击“安装”,安装完成后重启 VSCode。

二、配置 GraphQL Schema 自动加载

要启用字段级自动补全与类型检查,VSCode 必须能读取当前项目的 GraphQL Schema 定义,可通过本地文件或远程端点获取。

1、在项目根目录下创建 .graphqlrc.yml 文件。

2、写入以下内容以指向本地 Schema 文件:
schema: ./src/schema.graphql

3、若使用远程 GraphQL 服务,改用:
schema: https://api.example.com/graphql
extensions:
  endpoints:
    default:
      url: https://api.example.com/graphql

Machine Translation
Machine Translation

聚合多个来源的AI翻译

下载

三、启用 GraphQL 文件关联与语法高亮

VSCode 需明确将 .graphql、.gql 和含 gql 模板字符串的 .ts/.js 文件识别为 GraphQL 语言,否则无法触发语言服务。

1、按下 Cmd+, 打开设置,搜索 files.associations

2、点击“在 settings.json 中编辑”,添加如下配置项:

"*.graphql": "graphql",
"*.gql": "graphql",
"javascript": {"language": "javascript"},
"typescript": {"language": "typescript"}

3、在 JS/TS 文件中,对模板字符串添加注释标记:
const query = /* GraphQL */ `query GetUser { user(id: "1") { name } }`;

四、集成 Apollo Client 工具

Apollo Client 提供了额外的开发时能力,包括运行时查询验证、操作提取与缓存可视化,可与 VSCode 深度协同。

1、在项目中安装 Apollo CLI:
npm install --save-dev @apollo/client apollo

2、创建 apollo.config.js,配置 client 服务端点与本地 Schema 路径。

3、在 VSCode 中安装 Apollo GraphQL 扩展(作者:Apollo GraphQL),启用后可在编辑器内直接执行查询并查看响应。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

50

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

199

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

91

2026.03.13

Python GraphQL API 开发实战
Python GraphQL API 开发实战

本专题系统讲解 Python 在 GraphQL API 开发中的实际应用,涵盖 GraphQL 基础概念、Schema 设计、Query 与 Mutation 实现、权限控制、分页与性能优化,以及与现有 REST 服务和数据库的整合方式。通过完整示例,帮助学习者掌握 使用 Python 构建高扩展性、前后端协作友好的 GraphQL 接口服务,适用于中大型应用与复杂数据查询场景。

23

2026.01.21

json数据格式
json数据格式

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

457

2023.08.07

json是什么
json是什么

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

549

2023.08.23

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

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

337

2023.10.13

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

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

83

2025.09.10

C++多线程并发控制与线程安全设计实践
C++多线程并发控制与线程安全设计实践

本专题围绕 C++ 在高性能系统开发中的并发控制技术展开,系统讲解多线程编程模型与线程安全设计方法。内容包括互斥锁、读写锁、条件变量、原子操作以及线程池实现机制,同时结合实际案例分析并发竞争、死锁避免与性能优化策略。通过实践讲解,帮助开发者掌握构建稳定高效并发系统的关键技术。

2

2026.03.16

热门下载

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

精品课程

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

共58课时 | 6.1万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

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

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