GraphQL查询文件扩展名规范及VS Code支持问题咨询
VS Code中GraphQL查询的相关支持问题解答
1. 存储查询的文件扩展名惯例
没有绝对严格的区分规则,行业里常用的扩展名包括.gql和.graphql,这两种既可以存查询也可以存Schema,很多团队会根据自身习惯做约定(比如用.graphql存Schema,.gql存查询,反过来的情况也存在)。少数场景下会用.gqls专门存Schema,但这并非通用惯例。
2. 基于Schema的查询语法高亮与智能提示
完全支持。安装VS Code官方的GraphQL for VS Code插件后,只要正确配置Schema路径即可:
- 可以在VS Code的
settings.json里设置graphql.schemaPath,指定你的Schema文件位置; - 也可以在项目根目录创建
.graphqlconfig或.graphqlrc配置文件,在其中声明Schema的来源(本地文件或远程端点)。
配置完成后,插件就能提供查询的语法高亮、自动补全、错误校验等智能提示功能。
3. 能否import查询
原生GraphQL语法不支持import,但可以通过工具链和插件配合实现:
- 在构建层面,比如Webpack环境下使用
graphql-tag/loader,或者用@graphql-tools/load-files这类工具,能够加载并导入.gql/.graphql文件中的查询; - VS Code的GraphQL插件支持在查询文件中用
# import "./path-to-query.gql"的语法来引用其他查询文件,不过这种语法需要插件识别,实际运行时还是要靠构建工具处理解析。
你之前尝试将查询放入.gql文件未成功,大概率是因为没有配置好插件的Schema路径,或是缺少对应的构建工具来处理文件导入。
内容的提问来源于stack exchange,提问作者Stupid Questions
相关产品推荐
相关产品推荐

