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

11次阅读

需安装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

三、启用 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),启用后可在编辑器内直接执行查询并查看响应。

text=ZqhQzanResources