Melhores práticas de formatação JSON: estrutura, nomes e estilo

JSON bem formatado é mais fácil de ler, depurar e manter. Estas boas práticas se aplicam a respostas de API, arquivos de configuração e armazenamento de dados.

Nomenclatura

• Use um estilo consistente (camelCase ou snake_case)
• Seja descritivo: createdAt em vez de ca
• Use plural para arrays: "items" em vez de "item"
• Evite abreviações: organizationId em vez de orgId
• Use prefixos is/has para booleanos: "isActive", "hasPermission"

Estrutura

• Evite aninhamento maior que 3 níveis
• Use arrays para coleções ordenadas, objetos para dados chave-valor
• Inclua null para campos opcionais ausentes (não os omita)
• Use ISO 8601 para datas: "2026-06-01T00:00:00Z"
• Use strings para enums: "status": "active" é mais claro que "status": 1

Estilo

• Pretty-print (2 espaços de indentação) em desenvolvimento para facilitar a depuração
• Minifique em APIs de produção para economizar largura de banda
• Evite vírgulas finais (inválidas em JSON)
• Comentários não são suportados — use campos de metadados

Exemplo bom vs. ruim

Ruim	Bom	Por quê
{"ca": "2026-01-01"}	{"createdAt": "2026-01-01T00:00:00Z"}	Nome descritivo + ISO 8601
{"item": [...]}	{"items": [...]}	Plural para arrays
{"status": 1}	{"status": "active"}	Enums de string são mais claros
{"userId": 1, "user_name": "A"}	{"userId": 1, "userName": "A"}	Consistência no estilo

Converta as chaves

Use nosso conversor de chaves JSON para camelCase ou chaves JSON para snake_case.