API Platform Conference 2024: meet the best PHP, JavaScript and API experts

Learn more about the event, register for the conference, and get ready for two days of inspiration, ideas, and knowledge-sharing with our incredible lineup of renowned specialists and advocates.

Run Live

Guide

Error resource for domain exceptions

design state

Note that we use the following configuration:

api_platform:
   defaults:
           rfc_7807_compliant_errors: true

// src/App/ApiResource.php
namespace App\ApiResource;
use ApiPlatform\Metadata\ErrorResource;
use ApiPlatform\Metadata\Exception\ProblemExceptionInterface;

We create a MyDomainException marked as an ErrorResource It implements ProblemExceptionInterface as we want to be compatible with the JSON Problem rfc7807

#[ErrorResource]
class MyDomainException extends \Exception implements ProblemExceptionInterface
{
    public function getType(): string
    {
        return 'teapot';
    }
    public function getTitle(): ?string
    {
        return null;
    }
    public function getStatus(): ?int
    {
        return 418;
    }
    public function getDetail(): ?string
    {
        return $this->getMessage();
    }
    public function getInstance(): ?string
    {
        return null;
    }
}
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\Operation;
#[ApiResource(
    operations: [
        new Get(provider: Book::class.'::provide'),
    ],
)]
class Book
{
    public function __construct(
        public readonly int $id = 1,
        public readonly string $name = 'Anon',
    ) {
    }
    public static function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
    {

We throw our domain exception

        throw new MyDomainException('I am teapot');
    }
}

// src/App/Tests.php
namespace App\Tests;
use ApiPlatform\Playground\Test\TestGuideTrait;
use ApiPlatform\Symfony\Bundle\Test\ApiTestCase;
final class BookTest extends ApiTestCase
{
    use TestGuideTrait;
    public function testBookDoesNotExists(): void
    {
        static::createClient()->request('GET', '/books/1', options: ['headers' => ['accept' => 'application/ld+json']]);

We expect the status code returned by our getStatus and the message inside detail for security reasons 500 errors will get their “detail” changed by our Error Provider you can override this by looking at the Error Provider guide.

        $this->assertResponseStatusCodeSame(418);
        $this->assertJsonContains([
            'detail' => 'I am teapot',
        ]);
    }
}

// src/App/Playground.php
namespace App\Playground;
use Symfony\Component\HttpFoundation\Request;
function request(): Request
{
    return Request::create('/books/1.jsonld', 'GET');
}

You can also help us improve this guide.