Cómo crear un borrador de JSON Schema a partir de campos documentados
Un borrador de JSON Schema hace explícita la estructura esperada de los datos. Es útil cuando la documentación describe campos, pero se necesita un punto de partida de validación legible por máquinas.
Empieza con el material adecuado.
- Qué aportas
- una especificación visible de respuesta de API.
- El resultado previsto
- Crea un borrador de JSON Schema que conserve los campos obligatorios documentados y señale los supuestos.
Cómo funciona el flujo de trabajo.
Asocia los campos documentados a tipos y requisitos, manteniendo claros los objetos anidados y los arrays. Señala las suposiciones sobre formatos, restricciones y dialecto del esquema cuando la fuente no los especifique.
Qué comprobar en el resultado.
Valida el esquema y prueba ejemplos conocidos como válidos e inválidos. No marques todos los campos documentados como obligatorios ni inventes reglas restrictivas solo porque produzcan un esquema ordenado.
Analiza el JSON antes de usarlo en otra aplicación y revisa sus valores reales. Una sintaxis válida confirma que un analizador puede leer la estructura; no confirma que los hechos extraídos sean correctos.
Aprende del ejemplo resuelto.
El ejemplo descargable es un objeto JSON. Compara su estructura y el tratamiento de valores ausentes con el resultado que necesitas y luego verifica tus propios valores frente a la fuente aportada.
El ejemplo proporcionado es ilustrativo. No es una ejecución registrada con tus datos.
Descarga el ejemplo ↓Úsalo con tu propio material.
- Abre la fuente con la que quieres trabajar y activa WebAct en esa pestaña.
- Copia la tarea de la sección principal, añade los campos o preferencias necesarios y revisa las acciones propuestas.
- Compara el primer resultado con la fuente. Pide una corrección o mejora concreta cuando haga falta.