Flag of Ukraine
SymfonyCasts stands united with the people of Ukraine
TRACK

APIs >

COURSE

Api Platform 3: APIs RESTful míticamente buenas

Buy Access to Course

Validación

English Español

Keep on Learning!

If you liked what you've learned so far, dive in!
Subscribe to get access to this tutorial plus
video, code and script downloads.

Start your All-Access Pass
Buy just this tutorial for $12.00
Previous Challenge

Next Challenge
Edit on GitHub

With a Subscription, click any sentence in the script to jump to that part of the video!

Login Subscribe

Los usuarios de nuestra API pueden estropear las cosas de muchas maneras, por ejemplo con un JSON incorrecto o haciendo tonterías como introducir un número negativo en el campo value. ¡Esto es oro de dragón, no deuda de dragón!

JSON no válido

Este capítulo trata sobre cómo manejar estas cosas malas con elegancia. Prueba con la ruta POST. Enviemos algo de JSON no válido. Pulsa Ejecutar. ¡Impresionante! ¡Un error 400! Eso es lo que queremos. 400 -o cualquier código de estado que empiece por 4- significa que el cliente -el usuario de la API- ha cometido un error. en concreto, 400 significa "petición errónea".

En la respuesta, el tipo es hydra:error y dice: An error occurred y Syntax Error. Ah, y este trace sólo se muestra en el entorno de depuración: no se mostrará en producción.

¡Así que esto es muy bonito! El JSON no válido se gestiona de forma automática.

Restricciones de validación de reglas de negocio

Probemos algo diferente, como enviar JSON vacío. Esto nos da el temido error 500. Boo. Internamente, la API Platform crea un objeto DragonTreasure... pero no establece ningún dato en él. Y luego explota cuando llega a la base de datos porque algunas de las columnas son null.

Y, ¡nos lo esperábamos! Nos falta la validación. Añadir validación a nuestra API es exactamente igual que añadir validación en cualquier parte de Symfony. Por ejemplo, busca la propiedadname. Necesitamos que name sea obligatoria. Así que añade la restricción NotBlank, y pulsa tabulador. Oh, pero voy a buscar la declaración NotBlank use ... y cambiarla por Assert. Eso es opcional... pero es la forma en que los chicos guays suelen hacerlo en Symfony. Ahora di Assert\NotBlank:

190 lines src/Entity/DragonTreasure.php
... lines 1 - 19
use Symfony\Component\Validator\Constraints as Assert;
... lines 21 - 51
class DragonTreasure
{
... lines 54 - 61
#[Assert\NotBlank]
... line 63
private ?string $name = null;
... lines 65 - 188
}

A continuación, añade una más: Length. Digamos que el nombre debe tener al menos dos caracteres, max 50 caracteres... y añade un maxMessage:Describe your loot in 50 chars or less:

190 lines src/Entity/DragonTreasure.php
... lines 1 - 19
use Symfony\Component\Validator\Constraints as Assert;
... lines 21 - 51
class DragonTreasure
{
... lines 54 - 61
#[Assert\NotBlank]
#[Assert\Length(min: 2, max: 50, maxMessage: 'Describe your loot in 50 chars or less')]
private ?string $name = null;
... lines 65 - 188
}

Cómo se ven los errores en la respuesta

¡Buen comienzo! Inténtalo de nuevo. Coge ese mismo JSON vacío, pulsa Ejecutar, y ¡sí! ¡Una respuesta 422! Se trata de un código de respuesta muy común que suele significar que se ha producido un error de validación. Y ¡he aquí! El @type es ConstraintViolationList. Se trata de un tipo especial de JSON-LD añadido por API Platform. Anteriormente, lo vimos documentado en la documentación de JSON-LD.

Observa: ve a /api/docs.jsonld y busca un ConstraintViolation. ¡Ahí está! API Platform añade dos clases: ConstraintViolation yConstraintViolationList para describir el aspecto que tendrán los errores de validación. UnConstraintViolationList es básicamente una colección de ConstraintViolations... y luego describe cuáles son las propiedades de ConstraintViolation.

Podemos verlas aquí: tenemos una propiedad violations con propertyPathy luego la message debajo.

Añadir más restricciones

¡Vale! Vamos a añadir unas cuantas restricciones más. Añade NotBlank por encima de description... y GreaterThanOrEqual a 0 por encima de value para evitar los negativos. Por último, paracoolFactor utiliza GreaterThanOrEqual a 0 y también LessThanOrEqual a 10. Así que algo entre 0 y 10:

194 lines src/Entity/DragonTreasure.php
... lines 1 - 51
class DragonTreasure
{
... lines 54 - 68
#[Assert\NotBlank]
private ?string $description = null;
... lines 71 - 77
#[Assert\GreaterThanOrEqual(0)]
private ?int $value = null;
... lines 80 - 82
#[Assert\GreaterThanOrEqual(0)]
#[Assert\LessThanOrEqual(10)]
private ?int $coolFactor = null;
... lines 86 - 192
}

Y ya que estamos aquí, no necesitamos hacer esto, pero voy a inicializar$value a 0 y $coolFactor a 0. Esto hace que ambos no sean necesarios en la API: si el usuario no los envía, serán 0 por defecto:

194 lines src/Entity/DragonTreasure.php
... lines 1 - 51
class DragonTreasure
{
... lines 54 - 68
#[Assert\NotBlank]
private ?string $description = null;
... lines 71 - 77
#[Assert\GreaterThanOrEqual(0)]
private ?int $value = 0;
... lines 80 - 82
#[Assert\GreaterThanOrEqual(0)]
#[Assert\LessThanOrEqual(10)]
private ?int $coolFactor = 0;
... lines 86 - 192
}

Vale, vuelve a probar esa misma ruta. ¡Mira qué validación más bonita! Prueba también a poner coolFactor en 11. ¡Sí! Ningún tesoro mola tanto... bueno, a menos que sea un plato gigante de nachos.

Pasar tipos malos

Vale, hay una última forma de que un usuario envíe cosas malas: pasando un tipo incorrecto. Así que coolFactor: 11 fallará nuestras reglas de validación. Pero, ¿y si en su lugar pasamos un string? ¡Qué asco! Pulsa Ejecutar. Vale: un código de estado 400, eso es bueno. Aunque, no es un error de validación, tiene un tipo diferente. Pero indica al usuario lo que ha ocurrido:

el tipo del atributo coolFactor debe ser int, string dado.

¡Suficientemente bueno! Esto es gracias al método setCoolFactor(). El sistema ve el tipo int y por eso rechaza la cadena con este error.

Así que de lo único que tenemos que preocuparnos en nuestra aplicación es de escribir un buen código que utilice correctamente type y de añadir restricciones de validación: la red de seguridad que atrapa las violaciones de las reglas de negocio... como que value debe ser mayor que 0 o que descriptiones obligatorio. API Platform se encarga del resto.

A continuación: nuestra API sólo tiene un recurso: DragonTreasure. Añadimos un segundo recurso -un recurso User - para que podamos vincular qué usuario posee qué tesoro en la API.

Leave a comment!

Most Useful Newest Oldest
0
Login or Register to join the conversation
Cat in space

"Houston: no signs of life"
Start the conversation!

Symfony 6.2 API Platform 3.0

What PHP libraries does this tutorial use?

// composer.json
{
    "require": {
        "php": ">=8.1",
        "ext-ctype": "*",
        "ext-iconv": "*",
        "api-platform/core": "^3.0", // v3.0.8
        "doctrine/annotations": "^1.0", // 1.14.2
        "doctrine/doctrine-bundle": "^2.8", // 2.8.0
        "doctrine/doctrine-migrations-bundle": "^3.2", // 3.2.2
        "doctrine/orm": "^2.14", // 2.14.0
        "nelmio/cors-bundle": "^2.2", // 2.2.0
        "nesbot/carbon": "^2.64", // 2.64.1
        "phpdocumentor/reflection-docblock": "^5.3", // 5.3.0
        "phpstan/phpdoc-parser": "^1.15", // 1.15.3
        "symfony/asset": "6.2.*", // v6.2.0
        "symfony/console": "6.2.*", // v6.2.3
        "symfony/dotenv": "6.2.*", // v6.2.0
        "symfony/expression-language": "6.2.*", // v6.2.2
        "symfony/flex": "^2", // v2.2.4
        "symfony/framework-bundle": "6.2.*", // v6.2.3
        "symfony/property-access": "6.2.*", // v6.2.3
        "symfony/property-info": "6.2.*", // v6.2.3
        "symfony/runtime": "6.2.*", // v6.2.0
        "symfony/security-bundle": "6.2.*", // v6.2.3
        "symfony/serializer": "6.2.*", // v6.2.3
        "symfony/twig-bundle": "6.2.*", // v6.2.3
        "symfony/ux-react": "^2.6", // v2.6.1
        "symfony/validator": "6.2.*", // v6.2.3
        "symfony/webpack-encore-bundle": "^1.16", // v1.16.0
        "symfony/yaml": "6.2.*" // v6.2.2
    },
    "require-dev": {
        "doctrine/doctrine-fixtures-bundle": "^3.4", // 3.4.2
        "symfony/debug-bundle": "6.2.*", // v6.2.1
        "symfony/maker-bundle": "^1.48", // v1.48.0
        "symfony/monolog-bundle": "^3.0", // v3.8.0
        "symfony/stopwatch": "6.2.*", // v6.2.0
        "symfony/web-profiler-bundle": "6.2.*", // v6.2.4
        "zenstruck/foundry": "^1.26" // v1.26.0
    }
}
Edit on GitHub
Previous Challenge
Next Challenge
userVoice