Blog

Como formatar JSON e copiar o JSON Pointer de um valor

Formate no navegador uma resposta de API em uma linha e copie o JSON Pointer de um valor na árvore. Os exemplos também mostram como minificar e verificar a sintaxe.

A interface em inglês mostra o JSON em uma linha ao lado do resultado com recuo.

Quando uma API retorna JSON em uma linha, as quebras de linha facilitam a leitura. Se precisar informar que o segundo produto está sem estoque, inclua o caminho para que outra pessoa encontre o mesmo valor. Teste as duas operações com uma lista fictícia na ferramenta para formatar, minificar e validar JSON. Os dados colados são processados no navegador.

Como deixar legível uma resposta em uma linha

Cole o exemplo a seguir no campo “JSON de entrada”.

{"items":[{"sku":"A-001","stock":12},{"sku":"B-002","stock":0}]}
  1. Defina “Recuo” como 2 e clique em “Formatar →”.
  2. Em “Saída”, procure o segundo item do array items. O produto com sku B-002 tem stock igual a 0.
  3. Para salvar o resultado formatado em um arquivo, clique em “Copiar”, cole o conteúdo em um editor e salve. Se precisar de uma linha compacta, clique em “Minificar →” antes de copiar.
Na versão em inglês, a entrada mostra a lista de produtos e a saída mostra o JSON com recuo de dois espaços.
Os campos separados permitem comparar a linha original com a hierarquia formatada.

Como encontrar na árvore o caminho do estoque do segundo produto

  1. Mantenha a mesma entrada e clique em “Visualização em árvore”.
  2. Expanda items e [1], depois selecione "stock": 0. Os índices começam em zero, portanto [1] é o segundo item.
  3. Confira se o JSON Pointer selecionado é /items/1/stock e clique em “Copiar caminho”. Registre o caminho junto com a identificação da resposta que você consultou.
Na árvore em inglês, o segundo item de items está aberto e o caminho /items/1/stock aparece para o valor selecionado.
O campo de caminho indica onde está o valor selecionado. O valor em si é 0.

No JSON Pointer, a barra em uma chave vira ~1 e o til vira ~0. Por exemplo, a chave stock/on-hand vira stock~1on-hand. Consulte a sintaxe da RFC 6901.

Como verificar a sintaxe quando a formatação falha

Se você escrever o segundo item como {"sku":"B-002","stock":0,}, a vírgula antes da chave de fechamento provocará um erro de sintaxe. Clique em “Validar” para conferir. Se o navegador fornecer a posição do erro, a ferramenta mostrará a linha e a coluna. Remova a vírgula e clique novamente em “Validar” antes de formatar.

O botão “Validar” verifica a sintaxe do JSON. Consulte a especificação ou o esquema da API para saber, por exemplo, se stock é obrigatório ou aceita valores negativos.