feat(metadata): use a custom Attribute extends ApiResource (#5076)

[yobrx]

Q	A
Branch?	main
Tickets	#5076
License	MIT
Doc PR

Use a custom Attribute extending ApiResource class, see #5076

#[RestfulApi(
    routePrefix: '/live-chat',
)]
#[ORM\Entity]
class MyEntity
{
    #[ORM\Id]
    #[ORM\Column(type: 'integer')]
    #[ORM\GeneratedValue(strategy: 'AUTO')]
    private $id;

    public function __construct()
    {
    }

    public function getId()
    {
        return $this->id;
    }
}

use ApiPlatform\Metadata\ApiResource;

#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
class RestfulApi extends ApiResource
{
    public function __construct(
        ?string $routePrefix = null,
    ) {
        parent::__construct(
            routePrefix: $routePrefix,
            normalizationContext: ['groups' => ['restful_read']],
            denormalizationContext: ['groups' => ['restful_write']],
            openapiContext: ['tags' => ['LiveChat']],
            order: ['id' => 'DESC'],
            security: 'is_granted("ROLE_OPERATOR")'
        );
    }
}

[dunglas]

LGTM!

[yobrx]

Wait, many behat tests are broken... :(

[yobrx]

Behat tests are fixed !

It was broken because the name "ApiResource" was compared strictly in "AttributesResourceMetadataCollectionFactory.php"
Fix here ;
https://github.com/api-platform/core/compare/857438d850df2da14861dced02740348a4d80c97..7e0b746726d083ff7245b83a406172e0871d0192

[soyuka]

This is nice thanks! I'm wondering if we shouldn't support this as a bug fix instead as it should've been possible on 3.0. Could you target 3.0?

[yobrx]

This is nice thanks! I'm wondering if we shouldn't support this as a bug fix instead as it should've been possible on 3.0. Could you target 3.0?

Done !

[soyuka]

thanks @yobrx