Api-Platform 2.6（Symfony6）中如何将标识符作为查询参数？

针对你在Api-Platform 2.6 + Symfony 6中遇到的问题，需要调整资源配置并自定义数据提供者来实现通过查询参数传递标识符的需求，具体步骤如下：

1. 修正实体的ApiResource配置 #

首先修改SomeName实体的ApiResource注解，调整itemOperations的路径配置，同时添加OpenAPI文档的查询参数定义：

#[ApiResource(
    itemOperations: [
        'get' => [
            // 设置正确的资源路径，查询参数不在路由路径中定义
            'path' => '/some-name',
            'requirements' => [],
            'defaults' => ['_api_receive' => false],
            // 配置OpenAPI文档，显示查询参数
            'openapi_context' => [
                'parameters' => [
                    [
                        'name' => 'pathInfo',
                        'in' => 'query',
                        'required' => true,
                        'schema' => ['type' => 'string'],
                        'description' => '资源的路径标识符'
                    ]
                ]
            ]
        ]
    ]
)]
class SomeName
{
    #[ApiProperty(identifier: true)]
    private string $pathInfo;

    // 其他属性、构造方法及getter/setter
}

注意：之前错误地将路由路径设为"?pathInfo={pathInfo}"，这不符合Symfony路由规则，路由路径不能以?开头，查询参数是请求时附加的，不属于路由路径的一部分。

2. 自定义Item数据提供者 #

Api-Platform默认从路径变量中读取标识符，因此需要自定义数据提供者，从查询参数中获取pathInfo并查询对应的实体：

namespace App\DataProvider;

use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use App\Entity\SomeName;
use Doctrine\ORM\EntityManagerInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

class SomeNameItemDataProvider implements ItemDataProviderInterface, RestrictedDataProviderInterface
{
    private $entityManager;
    private $requestStack;

    public function __construct(EntityManagerInterface $entityManager, RequestStack $requestStack)
    {
        $this->entityManager = $entityManager;
        $this->requestStack = $requestStack;
    }

    // 限定仅处理SomeName实体的get操作
    public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
    {
        return $resourceClass === SomeName::class && $operationName === 'get';
    }

    public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
    {
        $request = $this->requestStack->getCurrentRequest();
        $pathInfo = $request->query->get('pathInfo');

        // 验证参数是否存在
        if (!$pathInfo) {
            throw new BadRequestHttpException('必须提供pathInfo参数');
        }

        // 查询对应实体
        $entity = $this->entityManager->getRepository(SomeName::class)->findOneBy(['pathInfo' => $pathInfo]);
        
        if (!$entity) {
            throw new NotFoundHttpException('未找到对应的SomeName资源');
        }

        return $entity;
    }
}

3. 注册数据提供者服务 #

Symfony 6会自动识别带有ItemDataProviderInterface的服务，若自动配置未生效，可在config/services.yaml中手动注册：

services:
    App\DataProvider\SomeNameItemDataProvider:
        arguments:
            $entityManager: '@doctrine.orm.default_entity_manager'
            $requestStack: '@request_stack'
        tags:
            - { name: api_platform.item_data_provider }

测试调用 #

完成配置后，即可通过GET /some-name/?pathInfo=/some/path/的方式请求API，Api-Platform会通过自定义数据提供者查询并返回对应的SomeName实体，同时OpenAPI文档会正确显示pathInfo查询参数。

内容的提问来源于stack exchange，提问作者Николай