# Validador de contrato de resposta API Valida um JSON de resposta real contra o schema declarado em uma especificacao OpenAPI 3.x > Página canônica: https://elysiatools.com/pt/tools/api-response-contract-validator - **Categoria:** Development - **Palavras-chave:** openapi, api, resposta, schema, contrato ## Visão geral Cole um documento OpenAPI 3.x e uma resposta real da API, depois informe path, method e status code. A ferramenta resolve o schema de resposta correspondente e destaca campos ausentes, erros de tipo, enums invalidos e campos nao documentados. Como usar: - Spec OpenAPI: cole YAML ou JSON - JSON de resposta: cole a carga real - Caminho / Metodo / Codigo de status: identifique a operacao e a resposta - Formato do spec: deixe auto se nao tiver certeza - Proibir campos extras: gera avisos para campos fora do schema ## Entradas - **Spec OpenAPI** (textarea): openapi: 3.0.3 paths: /users/{id}: ... - **JSON de resposta** (textarea): {"id":1,"name":"Alice"} - **Caminho** (text): /users/123 - **Metodo** (select) - **Codigo de status** (text): 200 - **Formato do spec** (select) - **Proibir campos extras** (checkbox) ## Quando usar - Quando você precisa verificar se as alterações recentes no backend quebraram o contrato da API estabelecido com o frontend. - Durante a criação de testes para validar se os payloads de resposta estão em total conformidade com a documentação OpenAPI. - Ao auditar APIs para garantir que os dados recebidos correspondem aos tipos e formatos esperados, evitando vazamento de dados não documentados. ## Como funciona - Cole a sua especificação OpenAPI 3.x (em formato YAML ou JSON) no campo designado. - Insira o payload JSON real retornado pela sua API no campo de resposta. - Defina o caminho (path), o método HTTP e o código de status correspondentes à operação que deseja validar. - Ative a opção de proibir campos extras se desejar ser alertado sobre propriedades não documentadas, e a ferramenta gerará um relatório destacando qualquer divergência. ## Casos de uso - Validação de regressão para garantir que novas implantações no backend não alterem a estrutura de resposta esperada pelos clientes. - Revisão de documentação de API, garantindo que o arquivo OpenAPI esteja sempre atualizado e reflita o comportamento real do servidor. - Depuração de erros de integração no frontend causados por mudanças silenciosas nos tipos de dados ou campos ausentes no payload. ## Perguntas frequentes ### Quais versões do OpenAPI são suportadas? A ferramenta suporta especificações no formato OpenAPI 3.x, podendo ser inseridas tanto em YAML quanto em JSON. ### O que acontece se a minha resposta JSON tiver campos não documentados? Por padrão, eles são ignorados. No entanto, se você marcar a opção 'Proibir campos extras', a ferramenta gerará avisos para qualquer campo que não esteja explicitamente declarado no esquema. ### Como a ferramenta sabe qual esquema validar? Ela utiliza o caminho (path), o método HTTP (como GET ou POST) e o código de status (ex: 200) que você fornece para localizar a resposta exata dentro da sua especificação OpenAPI. ### Posso validar respostas de erros, como 400 ou 500? Sim, basta inserir o código de status correspondente no campo 'Código de status' e garantir que essa resposta de erro esteja documentada na sua especificação OpenAPI. ### Preciso formatar o JSON de resposta antes de colar? Não é estritamente necessário formatar, desde que seja um JSON válido. A ferramenta fará a leitura e a validação estrutural automaticamente. ## Ferramentas relacionadas - [Gerador de JSON Schema](https://elysiatools.com/pt/tools/json-schema-generator): Infere JSON Schema a partir de JSON de exemplo com ajuste manual e validacao - [Ponte de PDF (OCR) para JSON estruturado](https://elysiatools.com/pt/tools/ocr-pdf-to-structured-json-bridge): Extrai a camada de texto do PDF com geometria (linhas por posição y, tabelas por vaos de coluna, títulos por tamanho de fonte, pares chave-valor com dois pontos) e preenche campo a campo um JSON Schema do usuário — rótulos pareados por chaves normalizadas, valores coagidos aos tipos declarados e validados com ajv. - [Construtor de link curto + UTM + QR](https://elysiatools.com/pt/tools/short-url-utm-builder-qr-bundle): Uma passada substitui o trio bit.ly + Campaign Builder + gerador de QR: informe a página de destino e os parâmetros UTM (trio obrigatório do GA4 validado, minúsculas opcional) e receba a URL completa rastreada; um slug base62 determinístico (hash FNV-1a, mesma entrada → mesmo slug, sem conta nem rede) no seu domínio curto; dois QR codes PNG (link curto e completo); mais os redirecionamentos nginx / vercel.json / Netlify e a linha CSV de acompanhamento de campanha. - [Divisor train/test com estratificação](https://elysiatools.com/pt/tools/train-test-split-with-stratification): Lê um dataset CSV/JSON e divide em train/validation/test com amostragem estratificada pela coluna alvo (70/15/15 padrão, semente reprodutível), ou k-fold estratificado; relatório de distribuição de classes por split com barras de desvio, checagem de vazamento por linhas duplicadas, prévia de SMOTE (interpolação de vizinhos no treino) e exportação dos CSV em ZIP. - [Validador JSON Schema](https://elysiatools.com/pt/tools/json-schema-validator): Valida dados JSON contra um JSON Schema para verificar estrutura e tipos de dados - [REPL interativo de JSONPath](https://elysiatools.com/pt/tools/jsonpath-repl-playground): Um REPL interativo de JSONPath que executa pipelines de consulta de várias etapas sobre qualquer JSON. Escreva uma expressão JSONPath por linha (ex. $..book\[?(@.price<10)\] depois $\[0:5\]) e veja as correspondências de cada etapa com contagens, caminhos e valores — além de uma URL compartilhável que codifica seus dados e pipeline. Suporta descida recursiva ($..), curingas (\[*\]), filtros (\[?(@.price<10)\]), slices (\[0:5:2\]) e índices negativos. - [OpenAPI para Postman Collection](https://elysiatools.com/pt/tools/openapi-to-postman-collection): Converte uma spec OpenAPI 3.x ou Swagger 2.0 (JSON/YAML) em uma Postman Collection v2.1.0 importável com pastas, variáveis, auth e respostas de exemplo. - [Gerador de OpenAPI para TypeScript](https://elysiatools.com/pt/tools/openapi-to-typescript-generator): Converte especificacoes OpenAPI ou Swagger em JSON/YAML em tipos TypeScript, parametros de requisicao e modelos de resposta com formato de saida e estilo de nomes configuraveis ## Exemplos - [Coleções Postman - Testes de API](https://elysiatools.com/pt/samples/postman-collections): Exemplos abrangentes de coleções Postman incluindo testes de API, scripts de automação, variáveis de ambiente, servidores mock e padrões avançados de teste para REST APIs - [Exemplos AWS EventBridge](https://elysiatools.com/pt/samples/eventbridge-samples): Exemplos AWS EventBridge incluindo event buses, regras, targets, schema registry, eventos personalizados e roteamento de eventos entre contas para arquitetura serverless event-driven - [Exemplos OpenAPI/Swagger](https://elysiatools.com/pt/samples/openapi-swagger): Exemplos abrangentes de documentação API usando OpenAPI 3.0 e especificações Swagger para serviços RESTful - [Exemplos de Rastreamento Distribuído](https://elysiatools.com/pt/samples/distributed-tracing-samples): Exemplos completos de rastreamento distribuído usando Jaeger, OpenTelemetry e ferramentas modernas de observabilidade ## Conteúdo relacionado - [Definição de contratos de API, validação de schemas e testes de mudanças](https://elysiatools.com/pt/hubs/api-contract-testing): Defina um contrato de API, valide schemas e payloads capturados, encontre riscos de compatibilidade e registre a aceitação. - [Versionamento de API e revisao de breaking changes](https://elysiatools.com/pt/hubs/api-versioning-breaking-change-review): Compare versoes de API, planeje migracoes e aceite a compatibilidade antes do release. As ferramentas nao substituem o deploy real nem o monitoramento. - [Ferramentas de utilidade, inspecao e transformacao JSON](https://elysiatools.com/pt/hubs/json-utility): Formate, inspecione, compare, mescle, transforme, valide, analise e marque JSON para fluxos de API e dados. - [Ferramentas de validação de JSON Schema e contratos de API](https://elysiatools.com/pt/hubs/json-validate): Compare validação de JSON Schema, checagem de resposta OpenAPI, mutation testing, stress testing e detecção de mudanças incompatíveis em um único hub para revisão de contratos de API.