By default ApiPlatform (opens new window) requires an ApiResource to have at least:

• A unique identifier: Used as id route parameter to generate the IRI for the ApiResource
• A GET item operation: The Symfony Router is used to generate the IRI for the ApiResource and it requires a route

This can be an issue in the case you want to create a custom API endpoint, not part of standard CRUD, to trigger an action of your choice.

This package provides different simple solutions to allow you to create any custom endpoint your business logic requires:

• No IRI Item: Allows you to create an ApiResource with no IRI support
• Self Provided IRI: Allows you to create an ApiResource that provide the IRI itself

No IRI Item

Did you ever try to create a custom API endpoint outside of the traditional CRUD using ApiPlatform? An API endpoint that doesn't return a traditional resource with an identifier? How easy was it? ...

Alright let's take a simple example, you want to implement an API endpoint as POST - /api/emails/send and this will return in the best case scenario something like:

{
    "message": "X emails successfully sent"
}

As explained ealier this example will be harder than expected to implement as ApiPlatform will require you to add an identifier on the ApiResource and an item operation that you won't ever use.

Here is the solution: EonX\EasyCore\Bridge\Symfony\ApiPlatform\Interfaces\NoIriItemInterface. When using the EasyCoreBundle in your application, simply make your ApiResource implement this interface will allow you to get rid of the errors and implement only what you really need.

// src/Api/Resource/EmailsSendResource.php

namespace App\Api\Resource;

use ApiPlatform\Core\Annotation\ApiResource;
use EonX\EasyCore\Bridge\Symfony\ApiPlatform\Interfaces\NoIriItemInterface;

/**
 * @ApiResource(
 *     collectionOperations={
 *         "post"={
 *             "path"="/emails/send"
 *         }
 *     },
 *     itemOperations={}
 * )
 */
final class EmailsSendResource implements NoIriItemInterface
{
    /**
     * @var string
     */
    private $message;

    public function getMessage(): ?string 
    {
        return $this->message;
    }

    public function setMessage(string $message): void
    {
        $this->message = $message;
    }
}

Self Provided IRI

In the previous example the created ApiResource didn't support IRI at all. This solution allows you to create ApiResources supporting IRI generation and control the way those IRIs are generated.

Use the EonX\EasyCore\Bridge\Symfony\ApiPlatform\Interfaces\SelfProvidedIriItemInterface.

// src/Api/Resource/EmailsSendWithIriResource.php

namespace App\Api\Resource;

use ApiPlatform\Core\Annotation\ApiResource;
use EonX\EasyCore\Bridge\Symfony\ApiPlatform\Interfaces\SelfProvidedIriItemInterface;

/**
 * @ApiResource(
 *     collectionOperations={
 *         "post"={
 *             "path"="/emails/send"
 *         }
 *     },
 *     itemOperations={}
 * )
 */
final class EmailsSendWithIriResource implements SelfProvidedIriItemInterface
{
    /**
     * @var string
     */
    private $message;

    public function getIri(): string
    {
        return '/emails/reports';
    }

    public function getMessage(): ?string 
    {
        return $this->message;
    }

    public function setMessage(string $message): void
    {
        $this->message = $message;
    }
}