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.

Elysia Tools

Navegação

Development

Validador de contrato de resposta API

Valida um JSON de resposta real contra o schema declarado em uma especificacao OpenAPI 3.x

Detalhes

O que esta ferramenta ajuda você a fazer

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

Execução

Executar esta ferramenta

Preencha o formulário, execute a ferramenta e veja o resultado no mesmo lugar.

Execuções de exemplo preparadas

Clique em um exemplo para preencher o formulário automaticamente. Arquivos ainda precisam ser enviados.

1 exemplos

Verificar se a resposta real ainda segue o schema de usuario

Valida uma resposta JSON real contra OpenAPI e detecta campos faltantes ou tipos incorretos.

<div>Contract validation issues</div>

Entradas

Preencha os campos necessários e execute a ferramenta.

7 opções

ConteúdoCole ou digite os valores principais.4

Spec OpenAPItextareaObrigatórioJSON de respostatextareaObrigatórioCaminhotextObrigatórioCodigo de statustextObrigatório

ConfiguraçõesAjuste formatos, intervalos, números e modos.2

MetodoselectOpcionalFormato do specselectOpcional

AlternânciasAtive ou desative comportamentos opcionais.1

Proibir campos extrascheckboxOpcionalAtivo quando marcado

Resultado

Pronto para executar

Depois de executar, arquivos, texto, dados estruturados ou saída em streaming aparecerão aqui.

Exemplos

Exemplos compatíveis com esta ferramenta

Relacionado

Validador de contrato de resposta API

O que esta ferramenta ajuda você a fazer

Executar esta ferramenta

Execuções de exemplo preparadas

Entradas

Resultado

Exemplos compatíveis com esta ferramenta

Continue com ferramentas e temas relacionados

Execuções de exemplo preparadas

Entradas

Resultado

Veja quando usar esta ferramenta, o que ela suporta e como os usuários a aplicam.

Fatos principais

Visão geral

Quando usar

Como funciona

Casos de uso

Exemplos

1. Validação de endpoint de usuário

2. Auditoria de campos não documentados

Perguntas frequentes

Coleções Postman - Testes de API

Exemplos AWS EventBridge

Exemplos OpenAPI/Swagger

Exemplos de Rastreamento Distribuído

Gerador de JSON Schema

Validador de Esquema JSON

REPL interativo de JSONPath

Gerador de OpenAPI para TypeScript

Ferramentas de validação de JSON Schema e contratos de API

Ferramentas de inspecao, diff e transformacao JSON

Ferramentas de teste de contrato de API, mocking e revisão de schemas

Ferramentas OpenAPI para documentação, geração de código e revisão de contrato