API Platform中GraphQL集合查询无法应用自定义过滤器问题

问题背景 #

在API Platform中，为REST接口编写的自定义集合过滤器能正常工作，但配置到GraphQL的collection_query后，仅在Schema和文档中显示，实际过滤逻辑不生效。原因是API Platform默认仅将过滤器应用于GET请求，而GraphQL的集合查询使用POST请求。

解决方案 #

方案1：修改自定义过滤器适配POST请求 #

在自定义过滤器类中，覆盖getDescription()方法，为过滤参数添加POST方法支持（同时保留GET支持，确保REST接口不受影响）。示例代码：

use ApiPlatform\Metadata\Operation;
use ApiPlatform\Doctrine\Orm\Filter\AbstractFilter;

class PointFilter extends AbstractFilter
{
    // ... 原有过滤逻辑代码

    public function getDescription(string $resourceClass): array
    {
        $description = parent::getDescription($resourceClass);
        
        // 为每个过滤参数添加POST方法支持
        foreach ($description as &$param) {
            $param['requirements']['method'] = ['GET', 'POST'];
        }
        
        return $description;
    }
}

方案2：为GraphQL集合查询自定义Resolver #

如果不想修改过滤器逻辑，可以为GraphQL的collection_query指定自定义Resolver，在Resolver中手动调用过滤器的处理逻辑：

1. 编写自定义Resolver类：

use ApiPlatform\GraphQl\Resolver\QueryCollectionResolverInterface;
use Doctrine\ORM\EntityManagerInterface;

class MyCollectionResolver implements QueryCollectionResolverInterface
{
    public function __construct(
        private EntityManagerInterface $em,
        private PointFilter $pointFilter,
        private ShippingMethodFilter $shippingMethodFilter
    ) {}

    public function __invoke(mixed $collection, array $context): mixed
    {
        $queryBuilder = $this->em->getRepository(YourResourceClass::class)->createQueryBuilder('r');
        
        // 手动应用两个过滤器的逻辑
        $this->pointFilter->apply($queryBuilder, $context['args'], YourResourceClass::class, null);
        $this->shippingMethodFilter->apply($queryBuilder, $context['args'], YourResourceClass::class, null);
        
        return $queryBuilder->getQuery()->getResult();
    }
}

2. 在ApiResource注解中关联该Resolver：

/** 
 * @ApiResource(
 *     graphql={
 *         "item_query",
 *         "collection_query"={
 *              "filters"={
 *                  PointFilter::class,
 *                  ShippingMethodFilter::class,
 *              },
 *              "resolver"=MyCollectionResolver::class
 *          },
 *     }
 * )
 */

方案3：全局开启过滤器的POST支持 #

如果需要让所有过滤器同时支持GET和POST请求，可以在API Platform的全局配置中设置：

# config/packages/api_platform.yaml
api_platform:
    filters:
        enable_post_filters: true

此配置会对所有过滤器生效，适合需要全局统一处理的场景。

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