Validador de JSON Schema

Como usar

1. Cole o esquema na primeira caixa e o documento que quer verificar na segunda. As duas guardam o que você digitou, então dá para fechar a página e voltar.
2. Olhe os cartões de resumo: válido ou não, quantos erros, qual draft foi usado e o tamanho do documento. A linha do draft diz ainda se ele veio do $schema ou do seletor.
3. Percorra as linhas de erro. Cada uma dá o JSON Pointer, a linha do seu documento, a palavra-chave que falhou, o valor que estava lá e o lugar dentro do esquema, para você decidir qual lado corrigir.
4. Abra uma linha de anyOf ou oneOf e leia os ramos. O marcado como mais próximo é o que falhou em menos coisas, que normalmente é o que você tinha em mente.
5. Ligue "Verificar format" quando quiser que format falhe em vez de apenas anotar: vem desligado porque a especificação o define como anotação e a maioria dos validadores deixa assim.

Perguntas frequentes

Por que meu documento passa quando eu esperava que falhasse?

Quase sempre porque o esquema diz menos do que parece dizer. JSON Schema ignora palavras-chave que não conhece, então "require" em vez de "required", "minlength" em vez de "minLength" ou uma palavra de 2020-12 dentro de um esquema draft-07 não é erro: é uma anotação que não faz nada. Objetos também aceitam propriedades extras a menos que additionalProperties ou unevaluatedProperties diga o contrário, arrays aceitam qualquer coisa sem items ou prefixItems, e format apenas anota até você ligar a verificação. Confira também o draft nos cartões: uma palavra-chave pode existir em um draft e não em outro, e aqui é ignorada a que o draft escolhido nunca teve.

1.0 é um inteiro?

Do draft 6 em diante, sim: a especificação define "integer" pelo valor, então 1.0 e 1.0e2 são inteiros e 1.5 não é. No draft 4, não: um número escrito com parte decimal é float e falha em "type": "integer". Esta ferramenta guarda como cada número foi escrito durante a análise, e é só por isso que consegue distinguir 1 de 1.0 — o JSON.parse entrega o mesmo valor para os dois. Se você valida com uma biblioteca antiga contra um esquema draft-04, essa diferença é fonte real de surpresas em produção, e trocar o seletor de draft aqui a reproduz.

Por que 0.3 não é múltiplo de 0.1?

Porque nenhum dos dois números é exato em ponto flutuante binário. 0.3 dividido por 0.1 dá 2.9999999999999996, não 3, e os validadores de referência testam exatamente esse quociente, então o documento é rejeitado. O mesmo esquema escrito como "multipleOf": 1 com o valor escalado para 3 passa. Não é mania desta ferramenta: python-jsonschema, ajv e os outros se comportam assim com multipleOf decimal, e por isso um esquema que quer dizer "duas casas decimais" fica melhor como pattern ou como um inteiro de centavos.

Como se lê o JSON Pointer de um erro?

Um ponteiro é um caminho de tokens separados por barras a partir da raiz do documento: /server/port é o membro port do objeto server e /tags/2 é o terceiro elemento de tags, porque os índices começam em zero. Um ponteiro vazio significa o documento inteiro, e é por isso que erros de required, additionalProperties e uniqueItems apontam para o objeto ou o array que os contém, e não para o membro: a propriedade ausente não tem lugar próprio. Uma barra dentro de um nome de propriedade se escreve ~1 e um til se escreve ~0. O número de linha ao lado do ponteiro é esta ferramenta resolvendo esse caminho no texto exato que você colou.

Por que outros validadores despejam tantos erros no anyOf?

Porque um anyOf que falhou realmente falhou em todos os ramos, e todos aqueles erros são verdadeiros. Um validador sem critério imprime todos lado a lado, então uma união de string e objeto vira uma lista em que "não é do tipo string" aparece junto de uma reclamação por propriedade ausente de um objeto que você nunca quis. Agrupar por ramo devolve a estrutura que o esquema já tinha, e escolher o ramo com menos falhas leva ao pretendido quase sempre. É heurística, não prova: quando dois ramos falham em uma coisa cada, a ferramenta marca o primeiro, e o esquema sozinho não diz qual você queria.

Ela segue um $ref para outro arquivo ou para uma URL?

Não, e isso é proposital: nada aqui toca a rede, então um $ref para https://example.com/user.json, ou para um arquivo vizinho como common.json#/$defs/id, não pode ser resolvido e é relatado como falha do esquema em vez de ser ignorado em silêncio. As referências dentro do texto colado funcionam por inteiro: #/$defs/name, um # sozinho, uma referência recursiva à raiz, um $anchor e um $id que outra referência nomeie. Para verificar um esquema espalhado em arquivos, junte tudo antes: cole as definições em $defs e reaponte as referências, que é o que a maioria das ferramentas faz antes de publicar um esquema.

Ferramentas relacionadas