Dominando o JSON
Formatar e validar JSON torna APIs mais fáceis de depurar, documentar e transmitir.
Por que o JSON é tão popular
Criado como alternativa leve ao XML, ele se encaixa naturalmente em objetos e arrays da maioria das linguagens.
A sintaxe legível o torna ideal para configs, respostas REST e protocolos de mensagens.
Benefícios de ordenar chaves
Ordenar chaves alfabeticamente torna documentos JSON mais fáceis de comparar no controle de versão.
A ordem consistente das chaves ajuda a identificar mudanças em arquivos de configuração e respostas de API.
Pretty-print vs minificar
Pretty-print adiciona espaços para leitura, ótimo para reviews ou docs.
Minificar remove caracteres supérfluos para reduzir banda e armazenamento em produção.
Quando usar o formatador
- Inspecionar payloads de webhooks vindos de terceiros
- Revisar mudanças de configuração antes de liberar feature flags
- Apresentar para o time o formato de uma nova resposta de API
- Compactar grandes datasets antes de salvá-los como fixtures
Boas práticas
- Valide contra um JSON Schema sempre que possível para garantir contratos
- Ordene chaves consistentemente para facilitar comparações no git
- Escape strings vindas do usuário antes de inseri-las em literais JSON
- Registre erros de parse com contexto (linha e coluna) para agilizar o diagnóstico