feat(metadata) Customize Resource & operations #7213

loic425 · 2025-06-13T14:18:33Z

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 · 2025-06-13T14:27:54Z

src/Metadata/Resource/Factory/CustomResourceMetadataCollectionFactory.php

+use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
+use Psr\Container\ContainerInterface;
+
+final class CustomResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface


Suggested change

final class CustomResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface

final class MutatorResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface

soyuka · 2025-06-13T14:28:58Z

src/Metadata/Resource/Factory/CustomResourceMetadataCollectionFactory.php

+
+        foreach ($resourceMetadataCollection as $resource) {
+            foreach ($this->resourceMutators->get($resourceClass) as $mutators) {
+                $resource = $mutators($resource);


an interface would be able for typehint to know what the callable arguments are and make the code a little bit cleaner

soyuka · 2025-06-26T07:48:33Z

src/Metadata/AsOperationMutator.php

+namespace ApiPlatform\Metadata;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class AsOperationMutator


Suggested change

final class AsOperationMutator

class AsOperationMutator

soyuka · 2025-06-26T07:48:58Z

src/Metadata/AsResourceMutator.php

+namespace ApiPlatform\Metadata;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class AsResourceMutator


Suggested change

final class AsResourceMutator

class AsResourceMutator

soyuka · 2025-06-26T07:49:48Z

src/Metadata/Mutator/OperationMutatorCollection.php

+use ApiPlatform\Metadata\OperationMutatorInterface;
+use Psr\Container\ContainerInterface;
+
+final class OperationMutatorCollection implements ContainerInterface


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

soyuka · 2025-06-26T07:53:19Z

src/Metadata/Mutator/OperationMutatorCollection.php

+{
+    private array $mutators;
+
+    public function addMutator(string $operationName, OperationMutatorInterface $mutator): void


Suggested change

public function addMutator(string $operationName, OperationMutatorInterface $mutator): void

/**

* Adds a mutator to the container for a given operation name.

*/

public function add(string $operationName, OperationMutatorInterface $mutator): void

soyuka · 2025-06-26T07:53:49Z

src/Metadata/Mutator/OperationMutatorCollection.php

+
+final class OperationMutatorCollection implements ContainerInterface
+{
+    private array $mutators;


Suggested change

private array $mutators;

private array $mutators = [];

soyuka · 2025-06-26T08:00:24Z

src/Metadata/Resource/Factory/MutatorResourceMetadataCollectionFactory.php

+     */
+    public function __construct(
+        private readonly ContainerInterface $resourceMutators,
+        private readonly ContainerInterface $operationMutators,


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)

soyuka · 2025-06-26T08:38:35Z

src/Symfony/Bundle/ApiPlatformBundle.php

@@ -62,5 +64,7 @@ public function build(ContainerBuilder $container): void
        $container->addCompilerPass(new TestMercureHubPass());
        $container->addCompilerPass(new AuthenticatorManagerPass());
        $container->addCompilerPass(new SerializerMappingLoaderPass());
+        $container->addCompilerPass(new ResourceMutatorPass());
+        $container->addCompilerPass(new OperationMutatorPass());


we should create only one pass

soyuka · 2025-06-26T08:39:29Z

src/Symfony/Bundle/DependencyInjection/Compiler/OperationMutatorPass.php

+
+        foreach ($mutators as $id => $tags) {
+            foreach ($tags as $tag) {
+                $definition->addMethodCall('addMutator', [


Suggested change

$definition->addMethodCall('addMutator', [

$definition->addMethodCall('add', [

soyuka · 2025-06-26T08:44:49Z

src/Symfony/Bundle/DependencyInjection/Compiler/ResourceMutatorPass.php

+
+        foreach ($mutators as $id => $tags) {
+            foreach ($tags as $tag) {
+                $definition->addMethodCall('addMutator', [


Suggested change

$definition->addMethodCall('addMutator', [

$definition->addMethodCall('add', [

soyuka · 2025-06-26T08:45:01Z

src/Symfony/Bundle/DependencyInjection/Compiler/ResourceMutatorPass.php

+            }
+        }
+    }
+}


merge both compiler passes

loic425 marked this pull request as draft June 13, 2025 14:18

loic425 force-pushed the customize-resource-and-operations branch from d9fd4f2 to 15dcaa4 Compare June 13, 2025 14:21

feat(metadata) Customize Resource & operations

7f165b9

loic425 force-pushed the customize-resource-and-operations branch from 15dcaa4 to 7f165b9 Compare June 13, 2025 14:21

soyuka requested changes Jun 13, 2025

View reviewed changes

loic425 force-pushed the customize-resource-and-operations branch from cb16e36 to 10140bd Compare June 16, 2025 12:41

Add Operation mutator

1b3ab0e

loic425 force-pushed the customize-resource-and-operations branch from 10140bd to 1b3ab0e Compare June 16, 2025 13:03

soyuka requested changes Jun 26, 2025

View reviewed changes

soyuka mentioned this pull request Jun 26, 2025

refactor(metadata): cascade resource to operation #7246

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(metadata) Customize Resource & operations #7213

feat(metadata) Customize Resource & operations #7213

Uh oh!

loic425 commented Jun 13, 2025 •

edited

Loading

Uh oh!

soyuka left a comment •

edited

Loading

Uh oh!

soyuka Jun 13, 2025

Uh oh!

soyuka Jun 13, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

soyuka Jun 26, 2025

Uh oh!

Uh oh!

	final class CustomResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
	final class MutatorResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface

-    public function addMutator(string $operationName, OperationMutatorInterface $mutator): void
+    /**
+     * Adds a mutator to the container for a given operation name.
+     */
+    public function add(string $operationName, OperationMutatorInterface $mutator): void

	$definition->addMethodCall('addMutator', [
	$definition->addMethodCall('add', [

Uh oh!

feat(metadata) Customize Resource & operations #7213

Are you sure you want to change the base?

feat(metadata) Customize Resource & operations #7213

Uh oh!

Conversation

loic425 commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

soyuka left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

loic425 commented Jun 13, 2025 •

edited

Loading

soyuka left a comment •

edited

Loading