feat(metadata) Customize Resource & operations

[loic425]

Q	A
Branch?	main
Tickets
License	MIT
Doc PR	api-platform/docs#...

The idea of this feature is to allow customizing built-in endpoints from a third party API (ex Sylius E-commerce API).

<?php

namespace App\Mutator;

use ApiPlatform\Metadata\AsResourceMutator;
use ApiPlatform\Metadata\ApiResource;
use App\Entity\Speaker;

#[AsResourceMutator(resourceClass: Speaker::class)]
final class SpeakerResourceMutator
{
    public function __invoke(ApiResource $resource): ApiResource
    {
        $operations = $resource->getOperations();
        $operations->remove('_api_Speaker_get_collection');

        return $resource->withOperations($operations);
    }
}

[soyuka]

Really cool, this is a follow up for php configured metadata as this allows to mutate vendor operations. I'll probably demonstrate this shortly.

I'd recommend to add a ResourceMutatorInterface. Obviously we should introduce an AsOperationMutator. I'd suggest that it takes:

public readonly string $operationName

URI Template would be nice as well but it will probably match several operations, therefore it's probably better to just use the $operationName.

[soyuka]

can you comment on this class to explain what its used for? Also mark it @internal no?

[soyuka]

I'm not sure container interface has any generic template, you can't phpdoc like you did or we need a new interface that inherits the container interface (which is alright)

[loic425]

I've created two interfaces, maybe we could merge to only once, but I'm not comfortable with generics.

[soyuka]

we should create only one pass

[loic425]

yes, done

[soyuka]

merge both compiler passes

[loic425]

done