Node.js中GraphQL使用@include指令报Unknown directive include错误
@include 是GraphQL规范定义的内置标准指令,由GraphQL运行时自动注入到服务端Schema中,不需要手动编写定义、也不需要在查询时做特殊配置。当前触发的Unknown directive "@include"报错,和前端查询逻辑、查询变量写法无关,问题完全出在服务端初始化Schema的流程上。
手动覆盖Schema默认指令配置
使用makeExecutableSchema构建Schema时,如果手动传入了directives参数,会直接替换掉运行时默认注入的内置指令列表,把@include、@skip这些标准指令全部覆盖。
触发问题的错误写法示例:// 这类写法会清空所有默认内置指令 const schema = makeExecutableSchema({ typeDefs, resolvers, directives: {} })修复方式:如果没有自定义指令需求,直接删除
directives配置项即可;如果有自定义业务指令,不要覆盖默认列表,要把自定义指令和内置指令做合并。手动实例化GraphQLSchema时遗漏内置指令
如果没有使用makeExecutableSchema工具,而是直接调用new GraphQLSchema()实例化Schema,需要手动把GraphQL包导出的内置指令合并到配置中:const { specifiedDirectives, GraphQLSchema } = require('graphql') // 自定义业务指令列表 const customBusinessDirectives = [] const schema = new GraphQLSchema({ // ...其他Schema配置项 directives: [...specifiedDirectives, ...customBusinessDirectives] })依赖版本不兼容
调整完配置仍报错时,检查本地graphql核心包与apollo-server系列包的版本兼容性,过旧版本的Apollo Server和新版graphql核心包搭配时,会出现内置指令加载逻辑异常,将两个依赖的版本调整到官方兼容范围即可。
你编写的查询语句、查询变量格式完全符合GraphQL规范:@include的参数类型Boolean!和传入的$withGames变量类型匹配,指令放置在字段后的语法也完全正确,不需要修改业务查询逻辑。
内容的提问来源于stack exchange,提问作者Luis

