API Platform take care of validating data sent to the API by the client (usually user data entered through forms). By default, the framework relies on the powerful Symfony Validator Component for this task, but you can replace it by your preferred validation library such as the PHP filter extension if you want to.
Validating submitted data is simple as adding Symfony’s built-in constraints
or custom constraints directly in classes marked with
the @ApiResource annotation:
<?php
// src/Entity/Product.php
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiResource;
use App\Validator\Constraints\MinimalProperties; // A custom constraint
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert; // Symfony's built-in constraints
/**
* A product.
*
* @ApiResource
* @ORM\Entity
*/
class Product
{
/**
* @var int The id of this product.
*
* @ORM\Id
* @ORM\GeneratedValue
* @ORM\Column(type="integer")
*/
private $id;
/**
* @var string The name of the product
*
* @Assert\NotBlank
* @ORM\Column
*/
private name;
/**
* @var string[] Describe the product
*
* @MinimalProperties
* @ORM\Column(type="json")
*/
private $properties;
// Getters and setters...
}
Here is a custom constraint and the related validator:
<?php
// src/Validator/Constraints/MinimalProperties.php
namespace App\Validator\Constraints;
use Symfony\Component\Validator\Constraint;
/**
* @Annotation
*/
class MinimalProperties extends Constraint
{
public $message = 'The product must have the minimal properties required ("description", "price")';
}
<?php
// src/Validator/Constraints/MinimalPropertiesValidator.php
namespace App\Validator\Constraints;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
/**
* @Annotation
*/
final class MinimalPropertiesValidator extends ConstraintValidator
{
public function validate($value, Constraint $constraint): void
{
if (!array_diff(['description', 'price'], $value)) {
$this->context->buildViolation($constraint->message)->addViolation();
}
}
}
If the data submitted by the client is invalid, the HTTP status code will be set to 400 Bad Request and the response’s
body will contain the list of violations serialized in a format compliant with the requested one. For instance, a validation
error will look like the following if the requested format is JSON-LD (the default):
{
"@context": "/contexts/ConstraintViolationList",
"@type": "ConstraintViolationList",
"hydra:title": "An error occurred",
"hydra:description": "properties: The product must have the minimal properties required (\"description\", \"price\")",
"violations": [
{
"propertyPath": "properties",
"message": "The product must have the minimal properties required (\"description\", \"price\")"
}
]
}
Take a look at the Errors Handling guide to learn how API Platform converts PHP exceptions like validation errors to HTTP errors.
Without specific configuration, the default validation group is always used, but this behavior is customizable: the framework is able to leverage Symfony’s validation groups.
You can configure the groups you want to use when the validation occurs directly through the ApiResource annotation:
<?php
// api/src/Entity/Book.php
use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Validator\Constraints as Assert;
/**
* @ApiResource(attributes={"validation_groups"={"a", "b"}})
* ...
*/
class Book
{
/**
* @Assert\NotBlank(groups={"a"})
*/
private $name;
/**
* @Assert\NotNull(groups={"b"})
*/
private $author;
// ...
}
With the previous configuration, the validations groups a and b will be used when validation is performed.
Like for serialization groups, you can specify validation groups globally or on a per operation basis.
Of course, you can use XML or YAML configuration format instead of annotations if you prefer.
You may also pass in a group sequence in place of the array of group names.
You can have different validation for each operation related to your resource.
<?php
// api/src/Entity/Book.php
use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Validator\Constraints as Assert;
/**
* @ApiResource(
* collectionOperations={
* "get",
* "post"={"validation_groups"={"Default", "postValidation"}}
* },
* itemOperations={
* "delete",
* "get",
* "put"={"validation_groups"={"Default", "putValidation"}}
* }
* )
* ...
*/
class Book
{
/**
* @Assert\Uuid
*/
private $id;
/**
* @Assert\NotBlank(groups={"postValidation"})
*/
private $name;
/**
* @Assert\NotNull
* @Assert\Length(
* min = 2,
* max = 50,
* groups={"postValidation"}
* )
* @Assert\Length(
* min = 2,
* max = 70,
* groups={"putValidation"}
* )
*/
private $author;
// ...
}
With this configuration, there are three validation groups:
Default contains the constraints that belong to no other group.
postValidation contains the constraints on the name and author (length from 2 to 50) fields only.
putValidation contains the constraints on the author (length from 2 to 70) field only.
If you need to dynamically determine which validation groups to use for an entity in different scenarios, just pass in a callable. The callback will receive the entity object as its first argument, and should return an array of group names or a group sequence.
In the following example, we use a static method to return the validation groups:
<?php
// api/src/Entity/Book.php
use ApiPlatform\Core\Annotation\ApiResource;
use Symfony\Component\Validator\Constraints as Assert;
/**
* @ApiResource(
* attributes={"validation_groups"={Book::class, "validationGroups"}}
* )
*/
class Book
{
/**
* Return dynamic validation groups.
*
* @param self $book Contains the instance of Book to validate.
*
* @return string[]
*/
public static function validationGroups(self $book)
{
return ['a'];
}
/**
* @Assert\NotBlank(groups={"a"})
*/
private $name;
/**
* @Assert\NotNull(groups={"b"})
*/
private $author;
// ...
}
Alternatively, you can use a service to retrieve the groups to use:
<?php
// api/src/Validator/AdminGroupsGenerator.php
namespace App\Validator;
use App\Entity\Book;
use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
final class AdminGroupsGenerator
{
private $authorizationChecker;
public function __construct(AuthorizationCheckerInterface $authorizationChecker)
{
$this->authorizationChecker = $authorizationChecker;
}
public function __invoke(Book $book): array
{
return $this->authorizationChecker->isGranted('ROLE_ADMIN', $book) ? ['a', 'b'] : ['a'];
}
}
This class selects the groups to apply regarding the role of the current user: if the current user has the ROLE_ADMIN role, groups a and b are returned. In other cases, just a is returned.
This class is automatically registered as a service thanks to the autowiring feature of the Symfony Dependency Injection Component. Just note that this service must be public.
Then, configure the entity class to use this service to retrieve validation groups:
<?php
// api/src/Entity/Book.php
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiResource;
use App\Validator\AdminGroupsGenerator;
use Symfony\Component\Validator\Constraints as Assert;
/**
* @ApiResource(attributes={"validation_groups"=AdminGroupsGenerator::class})
*/
class Book
{
/**
* @Assert\NotBlank(groups={"a"})
*/
private $name;
/**
* @Assert\NotNull(groups={"b"})
*/
private $author;
// ...
}
As stated in the Symfony documentation, you can use the payload field to define error levels.
You can retrieve the payload field by setting the serialize_payload_fields option to true in the API Platform config:
# api/config/packages/api_platform.yaml
api_platform:
validator:
serialize_payload_fields: true
Then, the serializer will return all payload values in the error response.
If you want to serialize only some payload fields, define them in the config like this:
# api/config/packages/api_platform.yaml
api_platform:
validator:
serialize_payload_fields: [ severity, anotherPayloadField ]
In this example, only severity and anotherPayloadField will be serialized.
Made with love by
Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.
Learn more