api-endpoint

Création Endpoint API Platform

Tu es un développeur Symfony et API Platform senior. Tu dois créer un endpoint API REST complet avec validation, documentation OpenAPI, pagination et tests.

Arguments

$ARGUMENTS

Arguments :

• Ressource (nom de l'entité)
• Opérations (list, get, post, put, patch, delete)

Exemple : /symfony:api-endpoint Product "list,get,post,patch,delete"

MISSION

Étape 1 : Configurer la Ressource API Platform

Entity avec API Platform Attributes

<?php

declare(strict_types=1);

namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\ApiFilter;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Patch;
use ApiPlatform\Metadata\Delete;
use ApiPlatform\Doctrine\Orm\Filter\SearchFilter;
use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
use ApiPlatform\Doctrine\Orm\Filter\DateFilter;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Serializer\Annotation\Groups;

#[ORM\Entity(repositoryClass: {Entity}Repository::class)]
#[ORM\Table(name: '{entities}')]
#[ApiResource(
    operations: [
        new GetCollection(
            uriTemplate: '/{entities}',
            normalizationContext: ['groups' => ['{entity}:list']],
            paginationEnabled: true,
            paginationItemsPerPage: 20,
        ),
        new Get(
            uriTemplate: '/{entities}/{id}',
            normalizationContext: ['groups' => ['{entity}:read']],
        ),
        new Post(
            uriTemplate: '/{entities}',
            denormalizationContext: ['groups' => ['{entity}:write']],
            validationContext: ['groups' => ['Default', '{entity}:create']],
            security: "is_granted('ROLE_USER')",
        ),
        new Patch(
            uriTemplate: '/{entities}/{id}',
            denormalizationContext: ['groups' => ['{entity}:write']],
            security: "is_granted('ROLE_USER') and object.getOwner() == user",
        ),
        new Delete(
            uriTemplate: '/{entities}/{id}',
            security: "is_granted('ROLE_ADMIN')",
        ),
    ],
    order: ['createdAt' => 'DESC'],
)]
#[ApiFilter(SearchFilter::class, properties: [
    'name' => 'partial',
    'status' => 'exact',
])]
#[ApiFilter(OrderFilter::class, properties: ['createdAt', 'name'])]
#[ApiFilter(DateFilter::class, properties: ['createdAt'])]
class {Entity}
{
    #[ORM\Id]
    #[ORM\Column(type: 'uuid', unique: true)]
    #[ORM\GeneratedValue(strategy: 'CUSTOM')]
    #[ORM\CustomIdGenerator(class: 'doctrine.uuid_generator')]
    #[ApiProperty(identifier: true)]
    #[Groups(['{entity}:list', '{entity}:read'])]
    private ?string $id = null;

    #[ORM\Column(length: 255)]
    #[Assert\NotBlank(groups: ['{entity}:create'])]
    #[Assert\Length(min: 3, max: 255)]
    #[Groups(['{entity}:list', '{entity}:read', '{entity}:write'])]
    private string $name;

    #[ORM\Column(type: 'text', nullable: true)]
    #[Groups(['{entity}:read', '{entity}:write'])]
    private ?string $description = null;

    #[ORM\Column(length: 50)]
    #[Assert\Choice(choices: ['draft', 'published', 'archived'])]
    #[Groups(['{entity}:list', '{entity}:read', '{entity}:write'])]
    private string $status = 'draft';

    #[ORM\Column(type: 'decimal', precision: 10, scale: 2, nullable: true)]
    #[Assert\PositiveOrZero]
    #[Groups(['{entity}:read', '{entity}:write'])]
    private ?string $price = null;

    #[ORM\ManyToOne(targetEntity: User::class)]
    #[ORM\JoinColumn(nullable: false)]
    #[Groups(['{entity}:read'])]
    private User $owner;

    #[ORM\Column(type: 'datetime_immutable')]
    #[Groups(['{entity}:list', '{entity}:read'])]
    private \DateTimeImmutable $createdAt;

    #[ORM\Column(type: 'datetime_immutable', nullable: true)]
    #[Groups(['{entity}:read'])]
    private ?\DateTimeImmutable $updatedAt = null;

    public function __construct()
    {
        $this->createdAt = new \DateTimeImmutable();
    }

    // Getters et Setters...
}