Como elaborar um JSON Schema a partir de campos documentados
Um rascunho de JSON Schema torna explícita a estrutura esperada dos dados. Ele é útil quando a documentação descreve campos, mas é necessário um ponto de partida de validação legível por máquina.
Comece com o material certo.
- O que você fornece
- uma especificação de resposta de API visível.
- O resultado pretendido
- Crie um rascunho de JSON Schema preservando os campos obrigatórios documentados e sinalizando suposições.
Como funciona o fluxo de trabalho.
Associe os campos documentados a tipos e requisitos, mantendo claros os objetos aninhados e os arrays. Identifique suposições sobre formatos, restrições e dialeto do esquema quando a fonte não os especificar.
O que conferir no resultado.
Valide o esquema e teste exemplos conhecidos como válidos e inválidos. Não marque todos os campos documentados como obrigatórios nem invente regras restritivas só porque produzem um esquema organizado.
Analise o JSON antes de usá-lo em outro aplicativo e confira seus valores reais. A sintaxe válida confirma que um analisador consegue ler a estrutura; não confirma que os fatos extraídos estão corretos.
Aprenda com o exemplo resolvido.
O exemplo para download é um objeto JSON. Compare sua estrutura e o tratamento de valores ausentes com o resultado necessário e depois confira seus valores com a fonte fornecida.
O exemplo fornecido é ilustrativo. Não é uma execução registrada com seus dados.
Baixe o exemplo ↓Use com seu próprio material.
- Abra a fonte com a qual quer trabalhar e ative o WebAct nessa aba.
- Copie a tarefa da seção principal, acrescente os campos ou preferências necessários e revise as ações propostas.
- Compare o primeiro resultado com a fonte. Peça uma correção ou um ajuste específico quando necessário.