API Platform中如何修改GetCollection生成Item IRI的默认Get操作

针对你遇到的API Platform中自定义/users/me端点与标准/users/{id}端点的冲突问题，有以下几种可行方案：

1. 强制指定实体的Item IRI模板 #

在ApiResource注解中添加itemUriTemplate属性，明确指定生成单个用户IRI时使用标准的/users/{id}模板，这样无论操作定义顺序如何，集合接口返回的@id都会正确指向用户的ID路径：

#[ApiResource(
    itemUriTemplate: '/users/{id}', // 强制指定Item的IRI模板
    operations: [
        new Get(
            uriTemplate: '/users/me',
            controller: UserBasicInfo::class,
            description: '获取当前用户基础信息',
            normalizationContext: ['groups' => ['user:me:get']],
            security: "is_granted('IS_AUTHENTICATED_FULLY')",
            securityMessage: '访问被拒绝',
            read: false,
            write: false,
            name: "api_users_get_self",
        ),
        new Get(
            normalizationContext: ['groups' => ['user:get']],
            security: "is_granted('IS_AUTHENTICATED_FULLY')",
            securityMessage: '访问被拒绝',
            read: true,
            name: "api_users_get_item",
        ),
        // 其他操作...
    ],
    paginationEnabled: true,
)]

这个方案直接绕过了API Platform默认使用第一个Get操作生成IRI的规则，从根源上解决集合返回@id错误的问题，同时保留/users/me的操作优先级。

2. 给标准/users/{id}操作添加路由约束 #

将标准Get操作的uriTemplate改为带约束的格式，限制{id}必须匹配用户ID的格式（比如数字、UUID等），这样当访问/users/me时，不会匹配到/users/{id}的路由，而是优先匹配自定义的/users/me端点。同时保持标准Get操作在自定义操作之前，确保集合返回的@id正确：

#[ApiResource(
    operations: [
        new Get(
            uriTemplate: '/users/{id}',
            normalizationContext: ['groups' => ['user:get']],
            security: "is_granted('IS_AUTHENTICATED_FULLY')",
            securityMessage: '访问被拒绝',
            read: true,
            name: "api_users_get_item",
            // 添加路由约束，假设用户ID是数字
            requirements: ['id' => '\d+']
        ),
        new Get(
            uriTemplate: '/users/me',
            controller: UserBasicInfo::class,
            description: '获取当前用户基础信息',
            normalizationContext: ['groups' => ['user:me:get']],
            security: "is_granted('IS_AUTHENTICATED_FULLY')",
            securityMessage: '访问被拒绝',
            read: false,
            write: false,
            name: "api_users_get_self",
        ),
        // 其他操作...
    ],
    paginationEnabled: true,
)]

这个方案利用Symfony路由的匹配规则，让/users/me不会被误匹配到/users/{id}，同时保证标准Get操作的优先级，集合返回的@id自然正确。

3. 自定义IRI生成器（进阶方案） #

如果以上方案不符合你的需求，可以实现自定义的IriConverterInterface，在生成用户实体的IRI时，强制选择标准的/users/{id}操作，而不是第一个Get操作。不过这个方案需要编写额外的代码，适合有特殊需求的场景：

// src/Iri/CustomUserIriConverter.php
namespace App\Iri;

use ApiPlatform\Api\IriConverterInterface;
use ApiPlatform\Api\UrlGeneratorInterface;
use App\Entity\User;

class CustomUserIriConverter implements IriConverterInterface
{
    public function __construct(private readonly IriConverterInterface $decorated) {}

    public function getItemIriFromResource($item, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
    {
        if ($item instanceof User) {
            // 强制使用标准的用户Item操作生成IRI
            return $this->decorated->getIriFromOperation('api_users_get_item', $item, $referenceType);
        }

        return $this->decorated->getItemIriFromResource($item, $referenceType);
    }

    // 实现其他接口方法，直接委托给装饰的转换器
    public function getResourceFromIri(string $iri, array $context = []): object|array|null
    {
        return $this->decorated->getResourceFromIri($iri, $context);
    }

    public function getCollectionIriFromResourceClass(string $resourceClass, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
    {
        return $this->decorated->getCollectionIriFromResourceClass($resourceClass, $referenceType);
    }

    public function getIriFromOperation(string $operationName, $item = null, int $referenceType = UrlGeneratorInterface::ABS_PATH): string
    {
        return $this->decorated->getIriFromOperation($operationName, $item, $referenceType);
    }
}

然后在services.yaml中配置装饰器：

services:
    App\Iri\CustomUserIriConverter:
        decorates: api_platform.iri_converter
        arguments: ['@.inner']

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