Proveedor: Transformar Entidades en DTOs

Hey Arthur,

Ah, I think I see the problem. You want your DTOs to carry just enough #[ApiResource] metadata so that ApiPlatform knows how to generate proper IRIs, but you don't actually want them to expose their own operations or generate their own routes, right?

Yeah, #[ApiResource] always implies tp expose that as a resource, which by default means routes get registered.

I personally didn't try it but IIRC since ApiPlatform 3.3 you can set uriTemplate: null in #[ApiResource()] PHP attr. Then it should exist purely for metadata and no routes should be generated. Probably worth to try.

Also, another soft option might be to use extraProperties instead of stateOptions. Then in your provider, you can read it with $operation->getExtraProperties()['entityClass'] ?? null. That way you don’t need to rely on the Options state option at all.

As possible more advanced option - try to override the ResourceMetadataCollectionFactory if you want full control. You can decorate that and inject the stateOptions for your DTOs programmatically without having to sprinkle #[ApiResource] everywhere. That way, you can tell API Platform: "Here’s the DTO, link it to this entity,", but don’t create routes for it.

That’s a bit more work, but it should keep your DTOs clean and avoid conflicts I think. But haven't tried it myself either.

I hope this helps!

Cheers!

Thanks @Victor . Some nice creative ideas!!

You're welcome! I hope that helps, not sure what else you can do in this case.

Cheers!

Oh, I noticed that when using /api/users.json, everything generates correctly, even more so I don't know what the problem is. :(

Hey @Albert-K!

This error:

Unable to generate an IRI for the item of type \"App\ApiResource\UserApi\"

This almost always means that you have a UserApi object with a null id property... but not always :p. You mentioned going to /api/users.json works. So is the problem only when you go to /api/users/5.json to fetch a single User? If so, in this case, are you returning an array of UserApi objects or only a single UserApi object (or null)?

Cheers!

Oh, I didn't add this in the first message, the error:

Unable to generate an IRI for the item of type \"App\\ApiResource\\UserApi\" 

occurs with .jsonld, I tried the following endpoints in .jsonld and .json format:

/api/users.jsonld
/api/users/5.jsonld

/api/users.json
/api/users/5.json

Those in .jsonld format generate an error Unable to generate an IRI for the item of type \"App\\ApiResource\\UserApi\", while those in .json format work fine.

As far as I can see the error is caused by the IriConverter in the generateSymfonyRoute method in this code:

        $identifiers = $context['uri_variables'] ?? [];

        if (\is_object($resource)) {
            try {
                $identifiers = $this->identifiersExtractor->getIdentifiersFromItem($resource, $identifiersExtractorOperation, $context);
            } catch (InvalidArgumentException|RuntimeException $e) {
                // We can try using context uri variables if any
                if (!$identifiers) {
                    throw new InvalidArgumentException(sprintf('Unable to generate an IRI for the item of type "%s"', $operation->getClass()), $e->getCode(), $e);
                }
            }
        }

I set

#[ApiProperty(identifier: false)] 

in the DTO class over $id and /api/users.jsonld works fine, just without IRI for an individual user.

I had the same issue, identifier fixed it, thanks!

After that I got the same error when querying items, updating the api package fixed it

Hey @Albert-K!

Very strange issue - but good debugging. Everything about this feels simply like the id is missing on the DTO - I’m not sure why that would be the case. But I’m happy you have a workaround.

Cheers!