Usa JSON Schema para documentar contratos de API, validar payloads JSON y generar datos mock realistas para tests y demos.
Paso 1 – Empieza con un ejemplo real
- Pega una respuesta de API, payload de request o JSON de configuración real en el formateador primero.
- Mantén un ejemplo JSON canónico por endpoint para evitar que el esquema se desvíe con el tiempo.
Paso 2 – Genera un esquema base
- Usa el Generador de Schema para inferir tipos, campos requeridos y estructura anidada.
- Refina descripciones, formatos y restricciones (min/max, patterns) antes de producción.
Paso 3 – Valida JSON contra el esquema
- Pega tu esquema y payloads reales en el Validador de Schema.
- Corrige errores actualizando el JSON (bugs) o el esquema (cambios de contrato).
Paso 4 – Genera datos mock para pruebas
- Abre el Generador de Mock para crear payloads de ejemplo que coincidan con tu esquema.
- Usa seed + batch size para que los datos de test sean reproducibles y escalables.
Paso 5 – Comparte y reutiliza
- Versiona tus esquemas y enlázalos desde tu documentación de API.
- Genera código tipado (TypeScript/Java/etc.) a partir de ejemplos JSON estables.
Nota importante sobre funciones de JSON Schema
- Algunos esquemas dependen de palabras clave avanzadas como
$ref, anyOf, oneOf, y allOf. - Los validadores difieren en el soporte de drafts y keywords; para cumplimiento estricto, usa un validador completo de JSON Schema en CI.
Ejemplo: JSON → JSON Schema (simplificado)
// JSON input
{
"id": 1,
"name": "Maeve Winters",
"active": true,
"tags": ["developer", "backend"]
}
// Generated schema (example)
{
"type": "object",
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" },
"active": { "type": "boolean" },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "name", "active", "tags"]
}