"No item route associated with the type" for an ApiResource that's only available as an ApiSubresource?

[kevinreniers]

Hello

I'm trying to figure out how to correctly define the GET item operation for an ApiResource that should only be available as an ApiSubresource. Currently, I've defined two models: IP\Range and IP\Address. The latter is defined as an ApiSubresource of the former, and it's only unique within the former.

As such, two IP\Address models could uniquely exist with the same address "192.168.1.15", but within different IP\Range. I don't manage the underlying database and I can't ask the people who do to add unique ids to them, since they already have a unique composite id between the range_id and the ipaddress.

So, in the end, my GET route for address should look like /ranges/{rangeId}/addresses/{addressId}. Doing it like /addresses/{id} is impossible, since it'd be /addresses/192.168.1.15 for example, which is not globally unique.

Also, I do not control this underlying database, so I cannot make any changes to add unique identifiers to them. They're only unique within a Range.

I've already done the following, which just gives me the expected "No item route associated with the type" error.

<?php

declare(strict_types=1);

namespace App\Entity\Reporting\IPAM;

use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use App\Repository\Reporting\IPAM\AddressRepository;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;

#[ORM\Entity(repositoryClass: AddressRepository::class, readOnly: true)]
#[ORM\Table(name: 'ipaddress')]
#[ApiResource(
    collectionOperations: [],
    itemOperations: [],
    normalizationContext: ['address:read']
)]
class Address
{
    #[ORM\Id]
    #[ORM\Column(name: 'ipaddress', type: 'string')]
    #[Groups(['address:read'])]
    private string $address;

    #[ORM\Id]
    #[ORM\ManyToOne(targetEntity: Range::class)]
    #[ORM\JoinColumn(name: 'iprangeid', referencedColumnName: 'iprangeid')]
    #[Groups(['address:read'])]
    private Range $range;

    public function getAddress(): string
    {
        return $this->address;
    }

    public function getRange(): Range
    {
        return $this->range;
    }
}

<?php

declare(strict_types=1);

namespace App\Entity\Reporting\IPAM;

use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Annotation\ApiSubresource;
use App\Repository\Reporting\IPAM\RangeRepository;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;

#[ORM\Entity(repositoryClass: RangeRepository::class, readOnly: true)]
#[ORM\Table(name: 'iprange')]
#[ApiResource(
    collectionOperations: ['get'],
    itemOperations: ['get'],
    normalizationContext: ['range:read']
)]
class Range
{
    #[ORM\Id]
    #[ORM\Column(name: 'iprangeid', type: 'integer')]
    #[Groups(['range:read'])]
    private int $id;

    #[ORM\OneToMany(mappedBy: 'range', targetEntity: Address::class)]
    #[ORM\JoinColumn]
    #[ApiSubresource]
    private Collection $addresses;

    public function __construct()
    {
        $this->addresses = new ArrayCollection();
    }

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

    public function getAddresses(): Collection
    {
        return $this->addresses;
    }
}

Any help is appreciated. :)

[kevinreniers]

For anyone interested in this in the future, I solved it the following way:

• I set the "composite_identifier" of the "attributes" key of the ApiResource attribute to false. This forces API Platform to use my two database identifiers, "range" and "address" instead of a single default "id" composed of both.

• I then set the path of the default GET item route to a custom path.

    itemOperations: [
        'get' => [
            'method' => 'GET',
            'path' => '/ranges/{range}/addresses/{address}.{_format}',
        ],
    ],

• I then ran into issues because an IP address can contain dots, so I set the "identifier" property of "ApiProperty" attribute on $address to false. Then, I created a virtual slug property like so:

    #[ApiProperty(identifier: true)]
    public function getSlug(): string
    {
        return str_replace('.', '-', $this->address);
    }

I also updated my item route to say {slug} instead of {address} like so:

    itemOperations: [
        'get' => [
            'method' => 'GET',
            'path' => '/ranges/{range}/addresses/{slug}.{_format}',
        ],
    ],

• Then, I added a custom DataProvider that looks like this:

# services.yaml
App\DataProvider\AddressItemDataProvider:
    bind:
        $dataProvider: '@api_platform.doctrine.orm.default.item_data_provider'

<?php

declare(strict_types=1);

namespace App\DataProvider;

use ApiPlatform\Core\DataProvider\DenormalizedIdentifiersAwareItemDataProviderInterface;
use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use App\Entity\Reporting\IPAM\Address;
use function str_replace;

class AddressItemDataProvider implements RestrictedDataProviderInterface, DenormalizedIdentifiersAwareItemDataProviderInterface
{
    private ItemDataProviderInterface $dataProvider;

    public function __construct(ItemDataProviderInterface $dataProvider)
    {
        $this->dataProvider = $dataProvider;
    }

    public function getItem(string $resourceClass, $id, string $operationName = null, array $context = []): ?Address
    {
        return $this->dataProvider->getItem(
            $resourceClass,
            $this->replaceSlugIdentifier($id),
            $operationName,
            $context
        );
    }

    private function replaceSlugIdentifier(array $id): array
    {
        if (isset($id['slug'])) {
            $id['address'] = str_replace('-', '.', $id['slug']);
            unset($id['slug']);
        }

        return $id;
    }

    public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
    {
        return $resourceClass === Address::class;
    }
}

You need to do this because by setting the #[ApiProperty(identifier: true)] attribute, API Platform assumes you're using these properties as identifiers for your Doctrine entity, even though I have explicit #[ORM\Id] attributes. Since slug is a virtual property in my case, I'll eventually get an error by doctrine that "slug" isn't a field. That's why I decode the slug->address in the DataProvider and then remove "slug" from the $id array.

[soyuka]

There's a better way of doing that I'll document that asap.