Grupos de serialización: Elección de campos

if it helps anybody, the moment you modify the metadata and add attributes, etc, you need to clear the cache unless you run the profiler debug toolbar which does that for you. I was stuck wondering why it didn't worked and that was the reason, then after installing the debugger everything worked fine just by reloading.

Hey Reborto,

Thank you for this tip! Yeah, it's always a good idea to clear the cache first in any weird case, i.e. when things should work but somehow work not like you expect.

Cheers!

Hi guys, what the difference between normalization or denormalization contexts placed in ApiResource scope and explicitly for operations get/post/patch/...?

Hi @triemli

it will configure serializer behavior for serialize and deserialize operations, you will use groups to select what values you will need to pass from Entity to JSON and vice versa.

Cheers!

Hi Ryan,

I watched the API Platform 2 course. I plan to watch this one but for now I did not find the time to do it. I still searched if there was the same course "Automatic Serialization Groups" that was in API Platform 2 course in API Platform 3 course. I could not find it, and it seems that the old version does not work anymore. Do you have any idea about how to do something similar ?

Thank you for your excellent work !

Hey @Aurelien-A!

It's funny you ask about that - it was maybe the ONE thing I didn't include in the API Platform 3 tutorial and at least 2 people have asked about it :P. Here is the other conversation - https://symfonycasts.com/screencast/api-platform/install#comment-29468 - it looks like the feature should be implemented the same way... it's just that some class names changed.

Let me know if you try it and hit any hiccups.

Cheers!

Hello Ryan, you were right. With a little reworking of the code in your original course, I believe I've managed to reproduce the same operation. I'm leaving the code in question available here, perhaps it could be useful to someone.

Thanks for your help and congratulations for your work on Symfony :)

Ah, thank you for posing that! ❤️❤️❤️ Nice work!

Just to signal a little fault : DenormlizationContext should be DenormalizationContext in the title "DenormlizationContext: Controlling Writable Groups" ! (i see another but cannot find it after reading the course twice!) But very good job, many thanks !

Ah, thank you Pierre! Fixed up now :) https://github.com/SymfonyCasts/api-platform3/commit/d542951c3fb0f33f31eecf9a642edf5da1a02386

Hi support Team,

maybe you can share few examples with DTO ?

Thanks in advance

Hey @Mepcuk!

That's coming! Not until episode 3, but definitely it's coming. It was better to wait until ep3 than try to smash it in earlier - it deserves some space :).

Cheers!

Hi Ryan,

In this chapter you are talking about the DTO solution, are you going to do a course to explain how it works in Api Platform v3?

I've always used them in v2, to separate the Entities from the Api. But in v3 I encounter a problem I don't know how to solve.

The @id field in DTO looks like "@id": "/.well-known/genid/01e546d3f38c0b5d3b8a", and I don't find anyway to get the IRI instead. Do you know if it's possible?

Thank you in advance

Hey @Auro!

In this chapter you are talking about the DTO solution, are you going to do a course to explain how it works in Api Platform v3?

Yes! But not until episode 3 so we can give them proper attention.

The @id field in DTO looks like "@id": "/.well-known/genid/01e546d3f38c0b5d3b8a", and I don't find anyway to get the IRI instead. Do you know if it's possible?

Hmm. This is new to me. It's generating something called a "skolem", which I know almost nothing about. And so, I'm giving advice... without really understanding ;). Looking at the code, which is deep and complex, you could try:

A) Setting force_resource_class: true as under normalizationContext of your ApiResource.
B) There is a new, undocumented feature in API Platform 3.1 that allows you to, sort of, "tie" your DTO to your entity a bit closer. Looking at the code, this seems related - but there are a lot of layers to it, and I'm honestly not sure what it does or doesn't do. But I believe, above your ApiResource in your DTO, you would add <br />stateOptions: new DoctrineORMOptions(entityClass: MyClass::class)<br />

Part of the tricky thing here is that DTO can mean at least 2 different things: a class that actually has the ApiResource attribute on it and IS the resource, or you have that attribute on an entity, then use the input or output config.

Cheers!

Hi @weaverryan,

Thank you for your answer.

I've tried the two options, and this is my feedback:

A. This solution works perfectly if you use id as default identifier. Sadly is not my case, I use uuid, and I think there is a bug when using uuid.

in the IriConverter class, method generateSymfonyRoute, it calls the following:

$identifiers = $this->identifiersExtractor->getIdentifiersFromItem($resource, $identifiersExtractorOperation, $context);

and in the IdentifiersExtractor class the first line of the getIdentifiersFromItem method

if (!$this->isResourceClass($this->getObjectClass($item))) { return ['id' => $this->propertyAccessor->getValue($item, 'id')]; }

If I use id instead of uuid o replace this line by uuid in both case it works and generate correctly the @id.

Instead of hardcoding the id, i think that it should dynamically use the identifier property

B. Digging into the code, there is a stateOptions but it looks to only works with elasticsearchOptions for the moment.

I have an ultimate question about DTOs, what would be the equivalent of the DataTransformerInitializerInterface?

I'm trying to initialize/hydrate the DTO when working with PUT/PATCH methods, but i don't find any way to have the object initialized before the validation step.

Hi @Auro!

Thanks for the update - sorry it's proving so tricky!

Instead of hardcoding the id, i think that it should dynamically use the identifier property

I don't know this code well. But I agree that it seems odd that it is looking specifically for an id property

I have an ultimate question about DTOs, what would be the equivalent of the DataTransformerInitializerInterface?

In short, I don't know yet... because I haven't dug into this - that will be soon for episode 3. They do talk about this briefly in the upgrade doc - https://api-platform.com/docs/core/upgrade-guide/#datatransformers-and-dto-support - you're supposed to use state providers to load the DTO data - https://api-platform.com/docs/core/dto/#implementing-a-write-operation-with-an-input-different-from-the-resource - however, I'm not sure this works yet with relation to validation.

Sorry I can't be more helpful! If you find anything out, I'd love to know :)

Thank you for your help @weaverryan ,

For the first point i've open an issue

https://github.com/api-platform/api-platform/issues/2411

For the second one, I will wait for the episode 3. I'm already using state providers and it works fine for POST methods. The problem is how to bypass validate and hydrate the DTO before the state provider code is executed.

Just to give some feeback, i've found a solution that works, but not really sure if it's a hack or the correct way to go.

https://github.com/api-platform/core/issues/5451

api_platform:
    mapping:
        paths: ['%kernel.project_dir%/config/api_platform', '%kernel.project_dir%/src/Dto']

resources:
    App\DomainBundle\Entity\AdminUser:
        normalizationContext:
            groups: [ 'admin-user:read' ]
        denormalizationContext:
            groups: [ 'admin-user:write' ]
        operations:
            ApiPlatform\Metadata\GetCollection:
                output: App\Dto\Output\AdminUserOutput
                provider: App\State\AdminUserCollectionProvider
                filters:
                    - api_platform.filter.admin_user.order
                    - api_platform.filter.admin_user.search
            ApiPlatform\Metadata\Get:
                output: App\Dto\Output\AdminUserOutput
                provider: App\State\AdminUserItemProvider
            ApiPlatform\Metadata\Post:
                processor: App\State\UserProcessor
                validationContext:
                    groups: [ 'Default', 'password' ]
            ApiPlatform\Metadata\Patch:
                processor: App\State\UserProcessor
            ApiPlatform\Metadata\Put:
                processor: App\State\UserProcessor
            ApiPlatform\Metadata\Delete: ~

properties:
    App\DomainBundle\Entity\AdminUser:
        id:
            identifier: false

        uuid:
            identifier: true

<?php

namespace App\Dto\Output;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\Get;
use App\DomainBundle\Entity\AdminUser;
use Ramsey\Uuid\UuidInterface;
use Symfony\Component\Serializer\Annotation\Groups;

#[Get(shortName: 'AdminUser')]
final class AdminUserOutput
{
    #[ApiProperty(identifier: true)]
    public UuidInterface $uuid;

    #[ApiProperty(identifier: false)]
    #[Groups('admin-user:read')]
    public int $id;

    #[Groups('admin-user:read')]
    public string $email;

    public function __construct(AdminUser $admin)
    {
        $this->id = $admin->getId();
        $this->uuid = $admin->getUuid();
        $this->email = $admin->getEmail();
    }
}

Awesome - thank you for sharing this. I'll have to dig more deeply into it when I look at DTO's. I'm totally unfamiliar with having an operation - like Get() right on the class vs inside of ApiResource 🤔