Chapters

36 Chapters | 3:44:20 |

01

Configuración y formas de ampliar la API Platform

4:39
02

Proveedores de estado, procesadores y un campo personalizado

4:49
03

Decorar el proveedor de estado principal

4:47
04

Decorar el CollectionProvider

7:12
05

Procesador de estado más sencillo

5:47
06

Ejecutar Código "Al Publicar"

6:05
07

Recurso totalmente personalizado

4:19
08

Proveedor de estado de recursos personalizado

5:04
09

Utilizar un identificador personalizado (fecha)

7:35
10

Proveedor de elementos de recursos personalizados

3:26
11

Procesador de estado de recursos personalizado

6:48
12

Relacionar ApiResources personalizados

5:13
13

Incrustar DTO personalizados

4:47
14

Paginación en un Recurso Personalizado

8:18
15

Clase de usuario Dto

4:24
16

stateOptions + entityClass Magia

10:07
17

Entidades, DTO y el objeto "central

6:24
18

Proveedor: Transformar Entidades en DTOs

4:47
19

Entidad -> DTO Proveedor de estado del elemento

4:11
20

DTO -> Procesador del Estado de la Entidad

7:39
21

Aprovechar el procesador central

7:11
22

Controlar campos sin grupos

4:31
23

Otras estrategias de campo condicional

6:04
24

Validación y seguridad del DTO

6:13
25

MicroMapper: Mapeo DTO Central

10:11
26

Proveedor y procesador reutilizable Entidad->Dto

4:11
27

¡Rápido! Crear un DTO DragonTreasure

9:51
28

Dtos, mapeo y profundidad máxima de las relaciones

8:05
29

Hacer que DragonTreasureApi sea escribible

7:23
30

DTO y Seguridad

9:39
31

Seguridad en el campo con Parche

6:17
32

Activar un "Publicar

4:14
33

Campos de relación escribibles

5:09
34

Escribir en una relación de colección

5:08
35

Colección escribible mediante el PropertyAccessor

6:29
36

Validador más sencillo para comprobar el cambio de estado

7:23

> APIs > API Platform 3 Parte 3: Recursos personalizados

Buy Access to Course

21.

Aprovechar el procesador central

Autoplay

Keep on Learning!

If you liked what you've learned so far, dive in! Subscribe to get
access to this tutorial plus video, code and script downloads.

Start your All-Access Pass

Buy just this tutorial for $12.00

Previous Chapter

Next Chapter

With a Subscription, click any sentence in the script to jump to that part of the video!

¡Mira cómo vamos! En nuestro procesador de estados, hemos transformado con éxito el UserApien una entidad User. Así que ¡vamos a guardarla! Podríamos inyectar el gestor de entidades, persistir y vaciar... y darlo por terminado. Pero prefiero descargar ese trabajo al núcleoPersistProcessor. Busca ese archivo y ábrelo.

Hace la persistencia y el vaciado sencillos... pero también tiene una lógica bastante compleja para las operaciones de PUT. En realidad, no las vamos a utilizar, pero la cuestión es que es mejor reutilizar esta clase que intentar desarrollar nuestra propia lógica.

Llamar al Core PersistProcessor

A estas alturas, ya debería resultarte familiar cómo lo hacemos. Añade unprivate ProcessorInterface $persistProcessor... y para que Symfony sepa exactamente qué servicio queremos, incluye el atributo #[Autowire()], con service establecido en PersistProcessor (en este caso, sólo hay uno para elegir) ::class.

            Copy Code

                            Show All Lines

                        55 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 4
                            
            use ApiPlatform\Doctrine\Common\State\PersistProcessor;
        
                Show Lines

                                                    // ... line 6
                            
            use ApiPlatform\State\ProcessorInterface;
        
                Show Lines

                                                    // ... lines 8 - 10
                            
            use Symfony\Component\DependencyInjection\Attribute\Autowire;
        
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function __construct(
        
                    private UserRepository $userRepository,
        
                    #[Autowire(service: PersistProcessor::class)] private ProcessorInterface $persistProcessor,
        
                )
        
                {
        
                }
        
                Show Lines

                                                    // ... lines 22 - 53
                            
            }

¡Muy bonito! A continuación, guarda con $this->persistProcessor->process() pasando$entity, $operation, $uriVariables, y $context... que son todos los mismos argumentos que tenemos aquí arriba.

            Copy Code

                            Show All Lines

                        55 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 4
                            
            use ApiPlatform\Doctrine\Common\State\PersistProcessor;
        
                Show Lines

                                                    // ... line 6
                            
            use ApiPlatform\State\ProcessorInterface;
        
                Show Lines

                                                    // ... lines 8 - 10
                            
            use Symfony\Component\DependencyInjection\Attribute\Autowire;
        
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function __construct(
        
                    private UserRepository $userRepository,
        
                    #[Autowire(service: PersistProcessor::class)] private ProcessorInterface $persistProcessor,
        
                )
        
                {
        
                }
        
                Show Lines

                                                    // ... line 22
                            
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
        
                {
        
                Show Lines

                                                    // ... lines 25 - 28
                            
                    $this->persistProcessor->process($entity, $operation, $uriVariables, $context);
        
                Show Lines

                                                    // ... lines 30 - 31
                            
                }
        
                Show Lines

                                                    // ... lines 33 - 53
                            
            }

Ah, y como antes, cuando generamos esta clase, generó process() con un tipo de retorno void. Eso no es exactamente correcto. No tienes que devolver nada de los procesadores de estado, pero puedes hacerlo. Y lo que devuelvas -en este caso, devolveremos $data - se convertirá en última instancia en la "cosa" que se serializa y se devuelve al usuario. Si no devuelves nada, se utilizará$data.

            Copy Code

                            Show All Lines

                        55 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 4
                            
            use ApiPlatform\Doctrine\Common\State\PersistProcessor;
        
                Show Lines

                                                    // ... line 6
                            
            use ApiPlatform\State\ProcessorInterface;
        
                Show Lines

                                                    // ... lines 8 - 10
                            
            use Symfony\Component\DependencyInjection\Attribute\Autowire;
        
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function __construct(
        
                    private UserRepository $userRepository,
        
                    #[Autowire(service: PersistProcessor::class)] private ProcessorInterface $persistProcessor,
        
                )
        
                {
        
                }
        
                Show Lines

                                                    // ... line 22
                            
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
        
                {
        
                Show Lines

                                                    // ... lines 25 - 28
                            
                    $this->persistProcessor->process($entity, $operation, $uriVariables, $context);
        
                    return $data;
        
                }
        
                Show Lines

                                                    // ... lines 33 - 53
                            
            }

Establecer el id en el DTO

Vale, creo que esto debería funcionar (Famosas últimas palabras...).

symfony php bin/phpunit --filter=testPostToCreateUser

Y... falla. Seguimos recibiendo un error 400, y sigue siendoUnable to generate an IRI for the item.

Entonces... ¿qué pasa? Mapeamos el UserApi a un nuevo objeto User y guardamos el nuevoUser... lo que hace que Doctrine asigne el nuevo id a ese objeto entidad. Pero nunca cogemos ese nuevo id y lo volvemos a poner en nuestro UserApi.

Para solucionarlo, después de guardar, añade $data->id = $entity->getId().

            Copy Code

                            Show All Lines

                        56 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 4
                            
            use ApiPlatform\Doctrine\Common\State\PersistProcessor;
        
                Show Lines

                                                    // ... line 6
                            
            use ApiPlatform\State\ProcessorInterface;
        
                Show Lines

                                                    // ... lines 8 - 10
                            
            use Symfony\Component\DependencyInjection\Attribute\Autowire;
        
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function __construct(
        
                    private UserRepository $userRepository,
        
                    #[Autowire(service: PersistProcessor::class)] private ProcessorInterface $persistProcessor,
        
                )
        
                {
        
                }
        
                Show Lines

                                                    // ... line 22
                            
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
        
                {
        
                Show Lines

                                                    // ... lines 25 - 28
                            
                    $this->persistProcessor->process($entity, $operation, $uriVariables, $context);
        
                    $data->id = $entity->getId();
        
                    return $data;
        
                }
        
                Show Lines

                                                    // ... lines 34 - 54
                            
            }

Y si lo intentamos ahora...

symfony php bin/phpunit --filter=testPostToCreateUser

sigue fallando... ¡pero esta vez hemos llegado más lejos! La respuesta parece buena. Devuelve un código de estado 201 con la nueva información del usuario. Falla en la parte de la prueba en la que intenta utilizar la contraseña para iniciar sesión. Esto se debe a que nuestra contraseña está actualmente configurada como... TODO. Lo arreglaremos en un minuto.

Manejo de la operación de borrado

Pero primero, cuando establecimos el processor en el nivel superior #[ApiResource], éste se convirtió en el procesador de todas las operaciones: POST, PUT, PATCH, yDELETE. POST, PUT, y PATCH son todas prácticamente iguales: guardar el objeto en la base de datos. Pero DELETE es diferente: no estamos guardando, sino eliminando.

Para ello, consulta if ($operation instanceof DeleteOperationInterface).

            Copy Code

                            Show All Lines

                        65 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 6
                            
            use ApiPlatform\Metadata\DeleteOperationInterface;
        
                Show Lines

                                                    // ... lines 8 - 14
                            
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                Show Lines

                                                    // ... lines 17 - 25
                            
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
        
                {
        
                Show Lines

                                                    // ... lines 28 - 31
                            
                    if ($operation instanceof DeleteOperationInterface) {
        
                Show Lines

                                                    // ... lines 33 - 35
                            
                    }
        
                Show Lines

                                                    // ... lines 37 - 41
                            
                }
        
                Show Lines

                                                    // ... lines 43 - 63
                            
            }

Al igual que guardar, eliminar no es difícil... pero sigue siendo mejor descargar este trabajo al procesador de eliminación del núcleo de Doctrine. Así que, aquí arriba, copia el argumento... e inyecta otro procesador: RemoveProcessor... y cámbiale el nombre a$removeProcessor.

            Copy Code

                            Show All Lines

                        65 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 5
                            
            use ApiPlatform\Doctrine\Common\State\RemoveProcessor;
        
            use ApiPlatform\Metadata\DeleteOperationInterface;
        
                Show Lines

                                                    // ... lines 8 - 14
                            
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function __construct(
        
                Show Lines

                                                    // ... lines 18 - 19
                            
                    #[Autowire(service: RemoveProcessor::class)] private ProcessorInterface $removeProcessor,
        
                )
        
                {
        
                }
        
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
        
                {
        
                Show Lines

                                                    // ... lines 28 - 31
                            
                    if ($operation instanceof DeleteOperationInterface) {
        
                Show Lines

                                                    // ... lines 33 - 35
                            
                    }
        
                Show Lines

                                                    // ... lines 37 - 41
                            
                }
        
                Show Lines

                                                    // ... lines 43 - 63
                            
            }

Aquí abajo, di $this->removeProcessor->process() y pásale $entity,$operation, $uriVariables, y $context igual que al otro procesador.

            Copy Code

                            Show All Lines

                        65 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 5
                            
            use ApiPlatform\Doctrine\Common\State\RemoveProcessor;
        
            use ApiPlatform\Metadata\DeleteOperationInterface;
        
                Show Lines

                                                    // ... lines 8 - 14
                            
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function __construct(
        
                Show Lines

                                                    // ... lines 18 - 19
                            
                    #[Autowire(service: RemoveProcessor::class)] private ProcessorInterface $removeProcessor,
        
                )
        
                {
        
                }
        
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
        
                {
        
                Show Lines

                                                    // ... lines 28 - 31
                            
                    if ($operation instanceof DeleteOperationInterface) {
        
                        $this->removeProcessor->process($entity, $operation, $uriVariables, $context);
        
                Show Lines

                                                    // ... lines 34 - 35
                            
                    }
        
                Show Lines

                                                    // ... lines 37 - 41
                            
                }
        
                Show Lines

                                                    // ... lines 43 - 63
                            
            }

Una cosa clave a tener en cuenta es que vamos a return null. En el caso de una operación DELETE, no devolvemos nada en la respuesta... lo que conseguimos devolviendo null desde aquí. No tengo una prueba preparada para esto, pero haremos un acto de fe y supondremos que funciona. ¡Envíalo!

            Copy Code

                            Show All Lines

                        65 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 5
                            
            use ApiPlatform\Doctrine\Common\State\RemoveProcessor;
        
            use ApiPlatform\Metadata\DeleteOperationInterface;
        
                Show Lines

                                                    // ... lines 8 - 14
                            
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function __construct(
        
                Show Lines

                                                    // ... lines 18 - 19
                            
                    #[Autowire(service: RemoveProcessor::class)] private ProcessorInterface $removeProcessor,
        
                )
        
                {
        
                }
        
                public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
        
                {
        
                Show Lines

                                                    // ... lines 28 - 31
                            
                    if ($operation instanceof DeleteOperationInterface) {
        
                        $this->removeProcessor->process($entity, $operation, $uriVariables, $context);
        
                        return null;
        
                    }
        
                Show Lines

                                                    // ... lines 37 - 41
                            
                }
        
                Show Lines

                                                    // ... lines 43 - 63
                            
            }

Cifrar la contraseña

Sólo nos queda un problema por resolver: cifrar la contraseña. Ya lo hemos hecho antes, así que no pasa nada. Antes de hacer demasiado aquí, abre UserApi... y añade unpublic ?string $password = null... con un comentario. Esto siempre contendrá null o la contraseña "en texto plano" si el usuario envía una. Nunca vamos a necesitar manejar la contraseña "hash" en nuestra API, así que no necesitamos espacio para ello... ¡lo cual está muy bien!

De vuelta en el procesador, if ($dto->password), entonces sabemos que tenemos que aplicar el hash y establecerlo en el usuario. Si se está creando un nuevo usuario, siempre se establecerá... pero al actualizar un usuario, haremos que este campo sea opcional. Si no se establece, no haremos nada, de modo que se mantendrá la contraseña actual del usuario.

Para hacer el hash, arriba, añade un argumento más:private UserPasswordHasherInterface $userPasswordHasher. Luego, abajo,$entity->setPassword() se establece en $this->userPasswordHasher->hashPassword(), pasando a$entity (el objeto User ) y la contraseña simple: $dto->password.

            Copy Code

                            Show All Lines

                        69 lines
            |
            src/State/EntityClassDtoStateProcessor.php
        
                Show Lines

                                                    // ... lines 1 - 13
                            
            use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
        
                Show Lines

                                                    // ... line 15
                            
            class EntityClassDtoStateProcessor implements ProcessorInterface
        
            {
        
                public function __construct(
        
                Show Lines

                                                    // ... lines 19 - 21
                            
                    private UserPasswordHasherInterface $userPasswordHasher,
        
                )
        
                {
        
                }
        
                Show Lines

                                                    // ... lines 27 - 45
                            
                private function mapDtoToEntity(object $dto): object
        
                {
        
                Show Lines

                                                    // ... lines 48 - 60
                            
                    if ($dto->password) {
        
                        $entity->setPassword($this->userPasswordHasher->hashPassword($entity, $dto->password));
        
                    }
        
                Show Lines

                                                    // ... lines 64 - 66
                            
                }
        
            }

Uf. Intentemos de nuevo la prueba. Y... falla... con

La anotación "@El" de la propiedad UserApi::$password nunca se importó.

Así que... me he tropezado con el teclado y he añadido un @ de más. Elimínalo... e inténtalo de nuevo:

symfony php bin/phpunit --filter=testPostToCreateUser

¡Pasa! ¡Lo que significa que se ha registrado completamente utilizando esa contraseña! Aunque, oh oh, mira la respuesta JSON volcada: esto es después de que POST creara el usuario. En la respuesta JSON, se incluye la propiedad password en texto plano que el usuario acaba de establecer. ¡Vaya!

El flujo de una petición de escritura

Desglosemos esto. Nuestro proveedor de estado se utiliza para todas las operaciones GET, así como para la operación PATCH. Y fíjate, no vamos a establecer nunca la propiedad password. No queremos devolver ese campo en el JSON, así que, correctamente, no lo estamos mapeando desde nuestra entidad a nuestro DTO. ¡Eso está bien!

Pero la operación POST es la única situación en la que nunca se llama al proveedor. Estos datos se deserializan directamente en un nuevo objeto UserApi y se pasan a nuestro procesador. Esto significa que nuestro DTO sí tiene establecida la contraseña simple... Y, en última instancia, ese objeto DTO es lo que se serializa y se devuelve al usuario.

Esto es una forma larga de decir que, en UserApi, esta contraseña debe ser un campo de sólo escritura. El usuario nunca debería poder leerla. A continuación: hablemos de cómo podemos hacer personalizaciones como ésta dentro deUserApi, evitando la complejidad de los grupos de serialización.

3 Comments

Sort By

Teddy-B 20 days ago edited

Hello dear SymfonyCast,

I have created a Processor where I want to check if the is a new User entity being posted.
I want to create a additional resource/ new entity UserProfile when this happens.

But I keep getting an error: Unable to generate an IRI for the item of type "App\ApiResource\UserProfileApi"
I have dealt with this error before, but know I cant really figure out how to deal with in this situation.

I tried setting it up within the mapper, where I get the same issue, but it does create a UserProfile after creating the User entity.
I thought maybe if I create the user First within the StateProcessor with the $this->persistProcessor and then proceed with creating the UserProfile but it did not work out as I thought.

I have AppFixtures where I can succesfully create userProfile after creating a User with no problems, so I am a little stuck.

I was thinking about creating a eventSubscriber/ Listener that check if a new User has a UserProfile, if not then create one and store it
I hope to get some pointers how to resolve this issue.

State Processor:

public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
    {
        $stateOptions = $operation->getStateOptions();
        assert($stateOptions instanceof Options);
        $entityClass = $stateOptions->getEntityClass();
        
        $entity = $this->mapDtoToEntity($data, $entityClass);
        
        if ($operation instanceof DeleteOperationInterface) {
            $this->removeProcessor->process($entity, $operation, $uriVariables, $context);
            return null;
        }

        if($operation->getMethod() === "PUT"){
            foreach($context["request"]->attributes as $key => $property){
                if($key === 'data'){
                    $context["previous_data"] = $this->mapDtoToEntity($property, $entityClass);
                    // $property = $this->mapDtoToEntity($property, User::class);
                }
            }
            // $context["previous_data"] = $this->mapDtoToEntity($context["previous_data"], User::class);
        }

        // dd(['created entity' => $entity]);
        $this->persistProcessor->process($entity, $operation, $uriVariables, $context);
        
        if($operation->getMethod() === "POST" && assert($entity instanceof User)){
            // dd("it passes");
            // $getLatestUser = $this->entityManager->getRepository(User::class)->findOneBy([], ['id' => 'desc']);
            $newProfile = new UserProfileApi();
            // $sequenceUser = $getLatestUser->getId();
            // $sequenceNr = $getLatestUser->getId() + 1;
            $newProfile->userUniq =  $this->mapDtoToEntity($entity, UserApi::class);
            // $newProfile->userUniq =  $this->mapDtoToEntity($entity, UserApi::class);/
            // $newProfile->userUniq = $sequenceNr;
            
            $userProfile = $this->microMapper->map($newProfile, UserProfile::class);
            
            // $userProfile->setUserUniq($entity);
            $this->entityManager->persist($userProfile);
            $this->entityManager->flush();
        }

        $data->id = $entity->getId();
        
        return $data;
        // $this->sendWelcomeEmail($data);
    }

    private function mapDtoToEntity($dto, $entityClass): object
    {
        return $this->microMapper->map($dto, $entityClass);
    }

UserProfileApi:

#[ApiResource(
    shortName: 'profile',
    provider: EntityToDtoStateProvider::class,
    processor: EntityClassDtoStateProcessor::class,
    paginationItemsPerPage: 10,
    stateOptions: new Options(entityClass: UserProfile::class),
    operations: [
        new Get(
            security: 'is_granted("ROLE_ADMIN")' 
        ),
        new GetCollection(
            security: 'is_granted("ROLE_ADMIN")' 
        ),
        new Post(
            security: 'is_granted("ROLE_ADMIN")' 
        ),
        new Patch(
            security: 'is_granted("ROLE_ADMIN")' 
        ),
        new Put(
            security: 'is_granted("ROLE_ADMIN")'
        ),
        new Delete(
            security: 'is_granted("ROLE_ADMIN")' 
        ),
    ],
    normalizationContext: [
        'groups' => ['profile:read']
            ],
    denormalizationContext: [
        'groups' => ['profile:write']
    ],
)]
class UserProfileApi
{
    public function __construct()
    {
        $this->postEvents = new ArrayCollection();
        $this->tokenManagers = new ArrayCollection();
        // $this->tokenManager = new TokenManagerApi();
        $this->subscribeToEvents = new ArrayCollection();
    }

    // #[Groups(["read_customer"])]
    #[ORM\Id, ORM\Column, ORM\GeneratedValue]
    #[Groups(['profile:read'])]
    #[ApiProperty(identifier: true)] // readable:false, 
    public ?int $id = null;

UserAPi Resource:

#[ApiResource(
    shortName: 'User',
    provider: EntityToDtoStateProvider::class,
    processor: EntityClassDtoStateProcessor::class,
    paginationItemsPerPage: 10,
    stateOptions: new Options(entityClass: User::class),
    operations: [
        new Get(    
            security: 'is_granted("ROLE_ADMIN")',     
            uriTemplate: '/user_by_email/{email}/email',
            uriVariables: 'email'
        ),
        new GetCollection(
            security: 'is_granted("ROLE_ADMIN")',     
        ),
        new Post(
            security: 'is_granted("PUBLIC_ACCESS")',
        ),
        new Patch(   
            security: 'is_granted("ROLE_ADMIN")',  
            uriTemplate: '/user_by_email/{email}/email',
            uriVariables: 'email'
        ),
        // new Patch(),
        new Put(
            security: 'is_granted("ROLE_ADMIN")',  
            uriTemplate: '/user_by_email/{email}/email',
            uriVariables: 'email'
        ),
        new Delete(
            security: 'is_granted("ROLE_ADMIN")', 
        ),
    ],
    normalizationContext: [
        'groups' => ['user:read']
    ],
    denormalizationContext: [
        'groups' => ['user:write']
    ],
)]
final class UserApi 
{
    public function __construct()
    {
        $this->userProfile = new UserProfileApi();
        $this->products = new ArrayCollection();
        $this->userAddresses = new ArrayCollection();
        $this->shopOrders = new ArrayCollection();
        $this->subscriptions = new ArrayCollection();
    }

    #[Groups(['user:read', 'profile:read'])]
    public ?int $id = null;

| Reply |

mcdzign 1 year ago

Hello Rayan

I have created a "UserApi mapper" to map the Doctrine User entity and a "BlogApi mapper" to map the Doctrine Blog entity. I try to create a sub-resource of the type /api/users/{id}/blogs, with itemUriTemplate: '/users/{userId}/blogs/{blogId}'. However, I get an error :

Example of how to reproduce a bug :

<?php

namespace App\ApiResource;

#[ApiResource(
    shortName: 'users',
    operations: [
        new Get(
            uriTemplate: '/users/{id}'
        ),
    ],
    provider: UserProvider::class,
    stateOptions: new Options(entityClass: User::class),
)]
class UserApi
{

    #[ApiProperty(readable: false, writable: false, identifier: true)]
    public ?int $id =null;
    #[Assert\NotBlank()]
    public ?string $username=null;
    /** @var BlogApi[]  */
    public array $blogs = [];
}

#[ApiResource(
    shortName: 'blogs',
    operations: [
        new Get(
            uriTemplate: '/users/{userId}/blogs/{blogId}',
            uriVariables: [
                'userId' => new Link(
                    toProperty: 'owner',
                    fromClass: User::class
                ),
                'blogId' => new Link(
                    fromClass: Blog::class
                ),
            ],

        ),
        new GetCollection(
            uriTemplate: '/users/{userId}/blogs',
            uriVariables: [
                'userId' => new Link(
                    toProperty: 'owner',
                    fromClass: User::class,
                ),
            ],
            denormalizationContext: [ 'force_resource_class' => Blog::class],
            itemUriTemplate: '/users/{userId}/blogs/{blogId}',
        )
    ],
    paginationItemsPerPage: 5,
    provider: BlogProvider::class,
    processor: BlogProcessor::class,
    stateOptions: new Options(entityClass: Blog::class)

)]

class BlogApi
{
    #[ApiProperty(readable: false, writable: false, identifier: true)]
    public ?int $id = null;
    public ?UserApi $owner = null;

}

   {
    "@context": "/api/contexts/Error",
    "@type": "hydra:Error",
    "hydra:title": "An error occurred",
    "hydra:description": "Unable to generate an IRI for the item of type \"App\\ApiResource\\BlogApi\"",
}

| Reply |

weaverryan SFCASTS mcdzign 1 year ago

Hey @mcdzign!

Hmm. That error - "Unable to generate an IRI" - can happen for several reasons, the simplest being that the BlogApi object (for some reason) has null for its id. But there are other things that can cause this. When I see this error, I open the profiler for that request (you can go to /_profiler to find the most recent requests) and then go to the Exceptions tab. This error will be on top, but usually there is a nested error further below that may give more granular details about what's going on. Do you see a 2nd exception message at the bottom?

Cheers!

| Reply |

Symfony 6.3 API Platform 3

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=8.1",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "api-platform/core": "3.1.x-dev", // 3.1.x-dev
        "doctrine/annotations": "^2.0", // 2.0.1
        "doctrine/doctrine-bundle": "^2.8", // 2.10.2
        "doctrine/doctrine-migrations-bundle": "^3.2", // 3.2.4
        "doctrine/orm": "^2.14", // 2.16.1
        "nelmio/cors-bundle": "^2.2", // 2.3.1
        "nesbot/carbon": "^2.64", // 2.69.0
        "phpdocumentor/reflection-docblock": "^5.3", // 5.3.0
        "phpstan/phpdoc-parser": "^1.15", // 1.23.1
        "symfony/asset": "6.3.*", // v6.3.0
        "symfony/console": "6.3.*", // v6.3.2
        "symfony/dotenv": "6.3.*", // v6.3.0
        "symfony/expression-language": "6.3.*", // v6.3.0
        "symfony/flex": "^2", // v2.3.3
        "symfony/framework-bundle": "6.3.*", // v6.3.2
        "symfony/property-access": "6.3.*", // v6.3.2
        "symfony/property-info": "6.3.*", // v6.3.0
        "symfony/runtime": "6.3.*", // v6.3.2
        "symfony/security-bundle": "6.3.*", // v6.3.3
        "symfony/serializer": "6.3.*", // v6.3.3
        "symfony/stimulus-bundle": "^2.9", // v2.10.0
        "symfony/string": "6.3.*", // v6.3.2
        "symfony/twig-bundle": "6.3.*", // v6.3.0
        "symfony/ux-react": "^2.6", // v2.10.0
        "symfony/ux-vue": "^2.7", // v2.10.0
        "symfony/validator": "6.3.*", // v6.3.2
        "symfony/webpack-encore-bundle": "^2.0", // v2.0.1
        "symfony/yaml": "6.3.*", // v6.3.3
        "symfonycasts/micro-mapper": "^0.1.0" // v0.1.1
    },
    "require-dev": {
        "doctrine/doctrine-fixtures-bundle": "^3.4", // 3.4.4
        "mtdowling/jmespath.php": "^2.6", // 2.6.1
        "phpunit/phpunit": "^9.5", // 9.6.11
        "symfony/browser-kit": "6.3.*", // v6.3.2
        "symfony/css-selector": "6.3.*", // v6.3.2
        "symfony/debug-bundle": "6.3.*", // v6.3.2
        "symfony/maker-bundle": "^1.48", // v1.50.0
        "symfony/monolog-bundle": "^3.0", // v3.8.0
        "symfony/phpunit-bridge": "^6.2", // v6.3.2
        "symfony/stopwatch": "6.3.*", // v6.3.0
        "symfony/web-profiler-bundle": "6.3.*", // v6.3.2
        "zenstruck/browser": "^1.2", // v1.4.0
        "zenstruck/foundry": "^1.26" // v1.35.0
    }
}

Previous Chapter

Next Chapter

Aprovechar el procesador central

Share this awesome video!

Keep on Learning!

Llamar al Core PersistProcessor

Establecer el id en el DTO

Manejo de la operación de borrado

Cifrar la contraseña

El flujo de una petición de escritura

3 Comments

Delete comment?

What PHP libraries does this tutorial use?

Show Lines	// ... lines 1 - 4
	use ApiPlatform\Doctrine\Common\State\PersistProcessor;
Show Lines	// ... line 6
	use ApiPlatform\State\ProcessorInterface;
Show Lines	// ... lines 8 - 10
	use Symfony\Component\DependencyInjection\Attribute\Autowire;

	class EntityClassDtoStateProcessor implements ProcessorInterface
	{
	public function __construct(
	private UserRepository $userRepository,
	#[Autowire(service: PersistProcessor::class)] private ProcessorInterface $persistProcessor,
	)
	{

	}
Show Lines	// ... lines 22 - 53
	}

Show Lines	// ... lines 1 - 6
	use ApiPlatform\Metadata\DeleteOperationInterface;
Show Lines	// ... lines 8 - 14
	class EntityClassDtoStateProcessor implements ProcessorInterface
	{
Show Lines	// ... lines 17 - 25
	public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
	{
Show Lines	// ... lines 28 - 31
	if ($operation instanceof DeleteOperationInterface) {
Show Lines	// ... lines 33 - 35
	}
Show Lines	// ... lines 37 - 41
	}
Show Lines	// ... lines 43 - 63
	}

Show Lines	// ... lines 1 - 5
	use ApiPlatform\Doctrine\Common\State\RemoveProcessor;
	use ApiPlatform\Metadata\DeleteOperationInterface;
Show Lines	// ... lines 8 - 14
	class EntityClassDtoStateProcessor implements ProcessorInterface
	{
	public function __construct(
Show Lines	// ... lines 18 - 19
	#[Autowire(service: RemoveProcessor::class)] private ProcessorInterface $removeProcessor,
	)
	{

	}

	public function process(mixed $data, Operation $operation, array $uriVariables = [], array $context = [])
	{
Show Lines	// ... lines 28 - 31
	if ($operation instanceof DeleteOperationInterface) {
Show Lines	// ... lines 33 - 35
	}
Show Lines	// ... lines 37 - 41
	}
Show Lines	// ... lines 43 - 63
	}

Show Lines	// ... lines 1 - 13
	use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
Show Lines	// ... line 15
	class EntityClassDtoStateProcessor implements ProcessorInterface
	{
	public function __construct(
Show Lines	// ... lines 19 - 21
	private UserPasswordHasherInterface $userPasswordHasher,
	)
	{

	}
Show Lines	// ... lines 27 - 45
	private function mapDtoToEntity(object $dto): object
	{
Show Lines	// ... lines 48 - 60
	if ($dto->password) {
	$entity->setPassword($this->userPasswordHasher->hashPassword($entity, $dto->password));
	}
Show Lines	// ... lines 64 - 66
	}
	}