JSON Schema para validación práctica de APIs
Usa JSON Schema para documentar y validar payloads de API con tipos, campos requeridos y restricciones claras.
JSON Schema permite describir la forma esperada de un documento JSON. En APIs, esa descripción sirve como contrato entre frontend, backend, pruebas y documentación.
Este artículo forma parte del cluster herramientas locales del navegador para depurar APIs. Cuando la salida de una conversión necesite comprobar el contrato, combina schemas con el flujo de convertir cURL a fetch o Axios.
No evita todos los bugs, pero reduce una clase entera de errores de estructura.
Qué puede validar
- Tipos: string, number, boolean, object, array y null.
- Propiedades requeridas.
- Longitudes, rangos y formatos.
- Estructuras anidadas.
- Enums y listas con elementos consistentes.
Dónde usarlo
Puedes usar JSON Schema en tests de integración, validación de requests, respuestas mock, fixtures y documentación. También es útil para revisar rápidamente un payload recibido desde logs.
Límites importantes
Un schema valida forma, no intención de negocio. Puede decir que email es string y que items es array, pero no reemplaza reglas como permisos, saldos o políticas de seguridad.
Idea clave
JSON Schema es mejor cuando se mantiene cerca del contrato real de la API. Si queda desactualizado, se convierte en otra fuente de confusión.
Consulta también la visión general del flujo de depuración de APIs.