Mejores prácticas de formato JSON: estructura, nombres y estilo

Un JSON bien formateado es más fácil de leer, depurar y mantener. Estas mejores prácticas se aplican a respuestas de API, archivos de configuración y almacenamiento de datos.

Nomenclatura

• Usa un estilo de mayúsculas consistente (camelCase o snake_case)
• Sé descriptivo: createdAt en lugar de ca
• Usa plural para arrays: "items" en lugar de "item"
• Evita abreviaturas: organizationId en lugar de orgId
• Usa prefijos is/has para booleanos: "isActive", "hasPermission"

Estructura

• Evita anidar más de 3 niveles
• Usa arrays para colecciones ordenadas, objetos para datos clave-valor
• Incluye null para campos opcionales faltantes (no los omitas)
• Usa ISO 8601 para fechas: "2026-06-01T00:00:00Z"
• Usa strings para enums: "status": "active" es más claro que "status": 1

Estilo

• Pretty-print (2 espacios de indentación) en desarrollo para facilitar la depuración
• Minifica en APIs de producción para ahorrar ancho de banda
• Evita comas finales (no son válidas en JSON)
• Los comentarios no son compatibles — usa campos de metadatos

Ejemplo bueno vs. malo

Malo	Bueno	Por qué
{"ca": "2026-01-01"}	{"createdAt": "2026-01-01T00:00:00Z"}	Nombre descriptivo + ISO 8601
{"item": [...]}	{"items": [...]}	Plural para arrays
{"status": 1}	{"status": "active"}	Enums de string son más claros
{"userId": 1, "user_name": "A"}	{"userId": 1, "userName": "A"}	Consistencia en el estilo

Convierte las claves

Usa nuestro conversor de claves JSON a camelCase o claves JSON a snake_case.