JSON Schema é um vocabulário que permite anotar e validar documentos JSON. Fornece um contrato para os seus dados JSON, definindo a estrutura, os tipos de dados e as regras de validação.O Apidog utiliza JSON Schema para definir estruturas de corpos de pedidos e respostas, permitindo a validação automática e a geração de documentação para as suas APIs.Esta página fornece uma breve introdução ao JSON Schema. Para obter detalhes completos sobre a especificação, a sintaxe e funcionalidades avançadas, consulte a Documentação do JSON Schema oficial. 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 esquemas
Garantir consistência entre pedidos e respostas de API
Casos de utilização comuns#
Definir esquemas de corpos de pedidos para endpoints POST/PUT/PATCH
Especificar estruturas de corpos de respostas para todos os métodos HTTP
Validar dados recebidos em relação aos formatos esperados
Gerar respostas mock automaticamente
Criar documentação de API abrangente
Saiba mais#
Comece com esquemas simples que definam tipos básicos e campos obrigatórios e, em seguida, adicione gradualmente regras de validação e restrições conforme necessário.