API Platform Con 2021: join us in Lille (France) or online on September 10 for our 1st international conference.
API Platform Con 2021: join us in Lille (France) or online on September 10 for our 1st international conference.
API Platform Con 2021: join us in Lille (France) or online on September 10 for our 1st international conference.

Validation

API Platform Admin manages automatically two types of validation: client-side validation and server-side (or submission) validation.

Client-side Validation

If the API documentation indicates that a field is mandatory, API Platform Admin will automatically add a required client-side validation.

For instance, with API Platform Core as backend, if you write the following:

<?php
// api/src/Entity/Book.php

use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ApiResource
 */
class Book
{
    /**
     * @Assert\NotBlank
     */
    public ?string $title = null;
}

If you create a new book and touch the "Title" field without typing, you will see:

Required title field

Server-side Validation

When the form is submitted and if submission errors are received, API Platform Admin will automatically show the errors for the corresponding fields.

To do so, it uses the submission validation feature of React Admin, and the mapping between the response and the fields is done by the schema analyzer with its method getSubmissionErrors.

API Platform Core is supported by default, but if you use another backend, you will need to override the getSubmissionErrors method.

For example if you have this code:

<?php
// api/src/Entity/Book.php

use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * @ApiResource
 */
class Book
{
    /**
     * @Assert\Isbn
     */
    public ?string $isbn = null;
}

If you submit the form with an invalid ISBN, you will see:

Submission error field