Api Platform+Symfony中自定义格式ID的API资源获取问题

核心问题 #

Api Platform默认的ObjectIdTransformer仅识别标准MongoDB ObjectId格式，导致带点的自定义ID被拦截，返回Hydra格式错误；自定义UriVariableTransformer未触发通常是优先级、服务注册或实体配置问题。

解决方案步骤 #

1. 实现高优先级自定义UriVariableTransformer #

创建自定义转换器，确保优先级高于默认的ObjectIdTransformer（默认优先级为0，设为100即可优先触发）：

<?php
namespace App\Transformer;

use ApiPlatform\Api\UriVariableTransformerInterface;
use ApiPlatform\Metadata\Operation;
use Doctrine\ODM\MongoDB\Types\Type;

class CustomMongoIdTransformer implements UriVariableTransformerInterface
{
    public function transform($value, array $types, Operation $operation, array $context = []): mixed
    {
        // 直接返回原始ID值，如需格式验证可在此添加正则逻辑
        return $value;
    }

    public function supportsTransformation($value, array $types, Operation $operation, array $context = []): bool
    {
        // 匹配实体ID的字符串类型，确保触发条件生效
        foreach ($types as $type) {
            if (Type::STRING === $type) {
                return true;
            }
        }
        return false;
    }
}

2. 正确注册转换器服务 #

在config/services.yaml中注册服务并设置标签优先级：

services:
    App\Transformer\CustomMongoIdTransformer:
        tags:
            - { name: api_platform.uri_variable_transformer, priority: 100 }

或在转换器类上直接添加属性（需开启Symfony自动装配）：

use ApiPlatform\Api\Attribute\AsUriVariableTransformer;

#[AsUriVariableTransformer(priority: 100)]
class CustomMongoIdTransformer implements UriVariableTransformerInterface
{
    // ...
}

3. 配置实体ID为自定义字符串类型 #

修改User实体的ID映射，告知MongoDB ODM使用自定义字符串ID而非默认ObjectId：

<?php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;

#[ApiResource]
#[ODM\Document(collection: 'users')]
class User
{
    #[ODM\Id(strategy: 'NONE', type: 'string')]
    private ?string $id = null;

    // 其他字段及getter/setter...

    public function getId(): ?string
    {
        return $this->id;
    }

    public function setId(string $id): self
    {
        $this->id = $id;
        return $this;
    }
}

关键配置：strategy: 'NONE'表示手动管理ID值，type: 'string'指定ID为字符串类型，支持任意格式。

4. 排查转换器未触发的常见原因 #

• 优先级设置过低：确保自定义转换器优先级高于默认的ObjectIdTransformer（默认0，设为100即可）
• supportsTransformation返回false：检查实体ID的类型是否与转换器中的匹配逻辑一致
• 服务未正确注册：确认标签或属性配置无误，Symfony容器能识别到该服务

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