JSON Schema es un vocabulario que le permite anotar y validar documentos JSON. Proporciona un contrato para sus datos JSON, definiendo la estructura, los tipos de datos y las reglas de validación.Apidog utiliza JSON Schema para definir las estructuras del cuerpo de peticiones y respuestas, lo que permite la validación automática y la generación de documentación para sus APIs.Esta página proporciona una breve introducción a JSON Schema. Para obtener detalles completos de la especificación, la sintaxis y las funciones avanzadas, consulte la Documentación de JSON Schema oficial. ¿Qué es JSON Schema?#
JSON Schema es una herramienta eficaz para:Validar datos JSON según reglas definidas
Documentar la estructura JSON esperada
Generar datos mock basados en definiciones de esquema
Garantizar la coherencia en las peticiones y respuestas de API
Casos de uso comunes#
Definir esquemas del cuerpo de la petición para endpoints POST/PUT/PATCH
Especificar estructuras del cuerpo de la respuesta para todos los métodos HTTP
Validar datos entrantes según los formatos esperados
Generar respuestas mock automáticamente
Crear documentación completa de API
Comience con esquemas simples que definan tipos básicos y campos obligatorios; luego, agregue gradualmente reglas de validación y restricciones según sea necesario.