Para que a API funcione de forma segura e previsível, é preciso controlar rigorosamente quais dados são aceitos e devolvidos. Nós implementamos a JSON Schema, uma descrição formal da estrutura de dados que permite a validação automática de pedidos e respostas no lado do servidor e do cliente.
A JSON Schema ajuda a identificar erros na fase de integração, eliminar comportamentos instáveis, garantir a compatibilidade entre os sistemas e aumentar a confiabilidade da interação com a API.
O que dá JSON Schema
| Opção | O que fornece |
|---|---|
| Verificar estrutura | Verifique se o objeto corresponde aos campos e tipos esperados |
| Campos obrigatórios | Controlar atributos críticos |
| Tipificação | Verificação clara de números, linhas, matrizes e matrizes |
| Limitações e formatos | Suporte de comprimento mínimo/máximo, enum, pattern, formato de email, etc. |
| Reutilizar | Criar modelos e componentes reutilizados |
Como a validação funciona
1. O pedido ou resposta é comparado a um esquema pré-definido
2. Se houver desvios, a API devolve o erro de explicação
3. Você pode combinar, herdar, usar regras condicional
4. Aplicável em qualquer nível, consulta, corpo, cabeçalhos, parâmetros query
Vantagens para API e clientes
Proteção contra dados incorretos e maliciosos
Maior estabilidade de integração e previsibilidade de comportamento
Teste automático e geração de mocos baseados em esquemas
Possibilidade de uso de esquemas em documentação e Swagger/OpenAPI
Simplificar o suporte e a escala da API
Onde é particularmente relevante
Plataformas com integração externa e API de parcerias
Aplicativos móveis e frontend à espera de uma estrutura clara de resposta
CI/CD piplyne com teste automático de API
Sistemas com configurações e contratos dinâmicos
A JSON Schema é uma tecnologia fundamental para uma API rigorosa e confiável. Torna os vossos dados validados, a integração segura e o desenvolvimento previsível.