JSON Schema é um vocabulário que permite anotar e validar documentos JSON. Ele fornece um contrato para seus dados JSON, definindo a estrutura, os tipos de dados e as regras de validação.O Apidog usa JSON Schema para definir estruturas de corpos de requisição e resposta, permitindo validação automática e geração de documentação para suas APIs.Esta página fornece uma breve introdução ao JSON Schema. Para obter detalhes completos sobre a especificação, sintaxe e recursos avançados, consulte a Documentação oficial do JSON Schema. O que é JSON Schema?#
JSON Schema é uma ferramenta poderosa para:Validar dados JSON em relação a regras definidas
Documentar a estrutura JSON esperada
Gerar dados de mock com base em definições de schema
Garantir consistência entre requisições e respostas de API
Casos de uso comuns#
Definir schemas de corpo de requisição para endpoints POST/PUT/PATCH
Especificar estruturas de corpo de resposta para todos os métodos HTTP
Validar dados recebidos em relação aos formatos esperados
Gerar respostas de mock automaticamente
Criar documentação de API abrangente
Saiba mais#
Comece com schemas simples definindo tipos básicos e campos obrigatórios e, em seguida, adicione gradualmente regras de validação e restrições conforme necessário.