Un formateador JSON y un validador JSON están relacionados, pero no resuelven el mismo problema. El formato hace que JSON sea más fácil de leer. La validación comprueba si el JSON se puede analizar. Antes de pegar un fragmento en documentos, un campo de configuración, un problema o una respuesta de soporte, es posible que necesite uno o ambos.
El Convertidor JSON/YAML/TOML de Converty mantiene esos trabajos juntos: valida la entrada, la formatea para su revisión, la minimiza cuando la salida compacta importa y la convierte cuando el siguiente sistema espera YAML o TOML.
Utilice un formateador cuando el JSON sea difícil de leer
El formateo tiene que ver con la presentación. Agrega sangría y saltos de línea para que la estructura sea más fácil de inspeccionar.
Utilice el formato cuando:
- una carga útil se minimiza en una línea
- los objetos anidados son difíciles de seguir
- Es necesario mostrar un ejemplo de API en la documentación.
- los revisores necesitan comparar campos rápidamente
- una respuesta de soporte necesita un fragmento legible
El formato no prueba que el ejemplo sea semánticamente correcto. Simplemente hace visible la estructura.
Utilice un validador cuando el JSON pueda no ser válido
La validación se trata de analizabilidad. Detecta problemas de sintaxis como comas faltantes, cadenas sin cerrar, comillas no válidas o anidamiento roto.
Utilice la validación antes de pegar JSON en un sistema que rechazará entradas no válidas. También es útil antes de compartir ejemplos porque los fragmentos no válidos hacen que el revisor pierda tiempo y hacen que la documentación sea menos confiable.
Utilice ambos antes de compartir ejemplos importantes
El flujo de trabajo más seguro es primero la validación y luego el formateo. Si el JSON no se analiza, corríjalo antes de preocuparse por la presentación. Una vez que sea válido, formatéelo para que los humanos puedan leerlo.
Esta secuencia es especialmente útil para ejemplos de API. Para obtener un flujo de trabajo centrado en compartir API, lea Cómo formatear JSON antes de compartir un ejemplo de API.
Cuando la conversión entra en escena
A veces, el siguiente sistema necesita YAML o TOML en lugar de JSON. La conversión es un tercer trabajo, independiente del formateo y la validación. Cambia la sintaxis al intentar preservar la estructura de datos.
No todas las estructuras se asignan claramente a todos los formatos, por lo que las advertencias de compatibilidad son importantes. Si la salida TOML no está disponible, lea Por qué la salida TOML no está disponible para algunas entradas JSON o YAML.
Abra el Convertidor JSON/YAML/TOML cuando necesite validar, formatear, minimizar o convertir datos estructurados antes de pegarlos en el siguiente flujo de trabajo.
