Provides an integration with the Symfony Messenger component

[dunglas]

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	api-platform/docs#708

This patch adds an easy way to dispatch messages to be handled asynchronously (or synchronously) using the Symfony Messenger component. It allows to create service-oriented endpoints very easily, but still in a restful way.

To be dispatched as a Symfony message, a resource just need to have be marked with messenger attribute:

<?php

namespace Dunglas\UserBundle\Entity;

use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ApiResource(
*      messenger=true,
 *     collectionOperations={
 *         "post"={"status"=202}
 *     },
 *     itemOperations={},
 *     outputClass=false
 * )
 */
class ResetPasswordRequest
{
    /**
     * @var string
     *
     * @Assert\NotBlank
     */
    public $username;
}

The corresponding Message handler:

<?php

namespace Dunglas\UserBundle\Handler;

use Symfony\Component\Messenger\Handler\MessageHandlerInterface;

final class ResetPasswordRequestHandler implements MessageHandlerInterface
{
    public function __invoke(ResetPasswordRequest $forgotPassword)
    {
        // do something with the resource
    }
}

It's an alternative to https://github.com/sroze/api-platform-messenger.

[ragboyjr]

@dunglas With the default configuration in sf messenger, how would oneself make a message handler that handled the remove message?

[ragboyjr]

Also, in the example posted above, would the swagger generated documentation properly reflect that no response is made?

[dunglas]

@dunglas With the default configuration in sf messenger, how would oneself make a message handler that handled the remove message?

For removal, you'll need a middleware, a simple handler would just get the message.

Also, in the example posted above, would the swagger generated documentation properly reflect that no response is made?

Not yet unfortunately, but it's something we're working on!

[bendavies]

just a niggle but your example relies on #2396.

https://github.com/krakphp/api-platform-extra also implemented this, FYI.

[Toflar]

So simple, yet so powerful. Loving it!
I've made a few remarks regarding possible future requests and just more flexibility in general but otherwise, super nice addition - well done!

[sroze]

I'd return the result of the HandledStamp instead if it exists.

[teohhanhui]

Could we have created a new ContextAwareDataPersisterInterface, so that the messenger attribute could be set at the operation level?