Property and @Groups() annotation to YAML

Given the entity below, how do I move the id and name, along with their annotated serialization groups, into the API Platform resource YAML (defined below the entity)?

I’ll create a PR for the docs project once I get this working.

src/Entity/Org.php

<?php declare(strict_types=1);

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;

/**
 * @ORM\Entity(repositoryClass="App\Repository\OrgRepository")
 */
class Org
{
    /**
     * @var int
     *
     * @Groups({"read"})
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @var string
     *
     * @Groups({"read", "write"})
     * @ORM\Column(type="string", length=128, unique=true, nullable=false)
     */
    private $name;

   // ...

config/api_platform/resources/Org.yaml

resources:
    App\Entity\Org:
        attributes:
            normalization_context:
                groups: ['read']
            denormalization_context:
                groups: ['write']
        collectionOperations:
            get: ~
            post: ~
        itemOperations:
            get: ~
            put: ~

[maks-rafalko]

They can, indeed. The problem is for the end user (developer) that it’s not clear how to move Annotations to Yaml for api-platform without this knowledge.

We tried to find example in the api-platform’s docs, we tried to check api-platform’s tests, we tried to debug and eventually found an answer in github issues.

All of these can be avoided with a properly documented case for Yaml usage.

It will significantly improve DX.

[mikemilano]

Confirmed, and for anyone else wondering like me, .yaml (in addition to .yml) extension works for files in the serializer directory as well.

Thanks @borNfreee, I’ll get a docs PR going this weekend.