如何编写GraphQL SPQR接口查询语句 解决查询验证失败问题

配置侧检查 #

• 确认Trade实体类的返回字段（如tradeId）存在公共getter方法，或已在字段上标注@GraphQLField注解，SPQR默认按getter映射返回字段，缺失getter会导致字段无法识别触发校验失败。
• 确认标注了@GraphQLApi的TradeService被Spring上下文正常扫描：如果你用的@Named是javax.inject包下的注解，需检查组件扫描范围是否包含该类所在包，也可临时替换为Spring原生@Service注解验证是否是扫描问题。
• 访问默认开启的GraphiQL调试页面（路径为/graphiql），查看左侧文档面板是否存在getTrades相关查询字段，若不存在说明该方法未被SPQR注册，问题出在配置环节。

查询语句检查 #

你的原有查询语法没有错误，报错大概率是SPQR默认命名策略导致的：SPQR默认会去掉Java查询方法的get/set/is前缀，再转成驼峰命名，getTrades方法默认会被映射为trades查询字段，而非保留原方法名。
你可以用如下两种方案任选其一解决：

1. 修改查询语句为：

{
  trades {
    tradeId
  }
}

2. 显式指定查询字段名，修改@GraphQLQuery注解为@GraphQLQuery(name = "getTrades")，即可沿用你原本的查询写法。

快速验证方式 #

打开GraphiQL调试页面，在查询编辑器中按Ctrl+空格唤起自动补全，按照自动补全提示的字段编写查询即可规避语法和命名问题。

内容的提问来源于stack exchange，提问作者Steve