Add Custom Operation to different Group in ApiPlatform docs

Question

I have a custom Operation CreatePerson which is dispatched via messenger.

/**
 * @ApiResource(
 *     messenger=true,
 *     output=false,
 *     shortName="person",
 *     collectionOperations={
 *         "post"
 *     },
 *     itemOperations={}
 * )
 *
 * @psalm-immutable
 */
final class CreatePerson

This works as expected with POST /api/people (people instead of person because ApiPlatform uses Inflection to pluralize the shortname on collectionOperations.

The API-Docs look like that:

I'd like to add a list of persons, too. So I created an other Api-Resource:

/**
 * @ApiResource(
 *     collectionOperations={
 *         "get"
 *     },
 *     itemOperations={}
 * )
 *
 * @psalm-immutable
 */
final class Person

The shortname of my customOperation ist person. This is also the group in the docs I want my list operation in.

Everything works as expected. Person and CreatePerson are two ApiResources. But now my docs look like that:

I want to group them both together in the API-Docs (because they belong together).

The reason why I use an extra CreatePerson-DTO here is because I use Api-Platform completely without doctrine. The DTO gets dispatched through messenger and creates a Person via Event-Sourcing. The Person-class is a readonly projection.

I don't understand. The command is CreatePerson. But the error message points to App\Entity\Person. Not possible to answer with this amount of detail. It is entirely possible to add custom operations this way (dto + messenger), so something else is amiss in your setup. — yivi
– yivi, Commented Jan 12, 2020 at 11:03
Yeah, but the clarification does not really clear things up for me. The previous revision had a configuration that seemed OK, but an error message that was not consistent with that configuration. I could answer this revision, but in the end I would just be repeating the configuration you had in the previous revision. Sorry. — yivi
– yivi, Commented Jan 12, 2020 at 12:19
The previous revision was me trying to hack around the problem. I found out why the group does not work as expected. I had to change the shortName="person" to shortName="Person" and that's it. — Patrick
– Patrick, Commented Jan 12, 2020 at 12:21

Patrick · Accepted Answer · 2020-01-12 14:17:29Z

-1

The solution for me was using openapi_context.

/**
 * @ApiResource(
 *     messenger=true,
 *     output=false,
 *     collectionOperations={
 *          "post"={
 *              "method"="POST",
 *              "path"="/people",
 *              "openapi_context"={
 *                  "tags"={
 *                      "Person"
 *                  },
 *             },
 *         },
 *     },
 *     itemOperations={},
 * )
 *
 * @psalm-immutable
 */
final class CreatePerson

And Person:

/**
 * @ApiResource(
 *     collectionOperations={
 *          "get"
 *     },
 *     itemOperations={},
 * )
 * @ORM\Entity(repositoryClass="App\Repository\PersonRepository")
 *
 * @psalm-immutable
 */
final class Person

(seen here: https://github.com/api-platform/docs/issues/143)

With the following result in the docs:

edited Jan 12, 2020 at 14:17

answered Jan 12, 2020 at 12:50

Patrick

1,6301 gold badge18 silver badges33 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Add Custom Operation to different Group in ApiPlatform docs

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related