Api Platform GraphQL自定义查询解析器未触发问题排查

问题场景代码 #

Product实体 #

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\GraphQl\Query;
use ApiPlatform\Metadata\GraphQl\QueryCollection;
use App\UI\ApiPlatform\Resolver\ProducsCollectionResolver;
use App\UI\ApiPlatform\Resolver\ProductResolver;

#[ApiResource(
    graphQlOperations: [
        new Query(
            resolver: ProductResolver::class,
        ),
        new QueryCollection(
            resolver: ProducsCollectionResolver::class,
        ),
    ]
)]
class Product
{
    public function __construct(
        private string $id,
        public string $name
    ){}
}

单个查询解析器 #

use ApiPlatform\GraphQl\Resolver\QueryItemResolverInterface;
use App\UI\ApiPlatform\Entity\Product;

final class ProductResolver implements QueryItemResolverInterface
{
    public function __invoke($item, array $context): Product
    {
        dump('here');
        return new Product('id', 'name');
    }
}

排查方案 #

• 修正类名拼写错误：实体中集合解析器的类名ProducsCollectionResolver少了一个t（应为ProductsCollectionResolver），拼写错误会导致容器无法识别服务，连带影响资源配置加载，修正后清除缓存重试。
• 验证解析器服务注册状态：执行bin/console debug:container ProductResolver，若找不到服务，说明类未被自动注册，需手动添加服务配置：

  services:
      App\UI\ApiPlatform\Resolver\ProductResolver:
          tags: ['api_platform.graphql.query_item_resolver']
  

  同步检查集合解析器的服务注册情况。
• 核对GraphQL查询格式：单个查询默认名称为product，正确查询格式应为：

  query {
    product(id: "your-id") {
      id
      name
    }
  }
  

  若使用IRI，需保证格式为"/products/your-id"，同时确认id字段被ApiPlatform识别为标识符（默认id字段会被识别，自定义配置需额外检查）。
• 检查Provider配置冲突：使用自定义Resolver时，ApiPlatform默认跳过Provider，若实体注解或全局配置（config/packages/api_platform.yaml）强制设置了provider参数，会引发冲突，确保全局配置中无如下强制设置：

  api_platform:
      defaults:
          provider: ~
  

• 清除缓存并重启服务：执行以下命令清除缓存：

  bin/console cache:clear --env=dev
  bin/console cache:warmup --env=dev
  

  生产环境切换对应环境参数。
• 对比正常服务配置差异：逐行对比当前Product资源与正常服务的配置：
  • 注解参数结构是否一致（如graphQlOperations的参数设置）
  • 解析器的命名空间、接口实现是否匹配（如是否正确实现QueryItemResolverInterface）
  • 实体字段的访问权限、构造函数是否有差异（如id为private时需提供getter方法，确保ApiPlatform可访问）
• 确认ApiPlatform版本兼容性：不同版本的ApiPlatform对GraphQL Resolver的要求有差异，对比正常服务使用的版本，确保当前项目版本一致。

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