Ferramentas de API

Validador OpenAPIrevise o contrato

Cole uma especificação JSON ou YAML, explore operações e leia os diagnósticos antes de exportar.

Validador OpenAPI

Fonte OpenAPI

Resultado

Nenhum endpoint de requisição correspondente.

Exibindo 0 de 0

A especificação fica neste navegador. Nenhuma chamada de API ou busca de referência remota é enviada.

Opções de saída

Verifica a estrutura e regras comuns de caminhos. A exportação inclui paths, sem webhooks ou callbacks. Exemplos e respostas reais não são testados.

500.000 caracteres · profundidade 60 · 50.000 nós · 100 diagnósticos · 5 segundos de validação.

Cole uma especificação ou carregue o exemplo.

A cópia e o download usam a visualização selecionada. A exportação de endpoints inclui a lista completa, independentemente da busca.

O Validador OpenAPI ajuda na revisão de contratos gerados automaticamente. Um arquivo pode ser JSON ou YAML válido e ainda omitir a descrição de uma resposta ou a declaração de um parâmetro no caminho.

Confira primeiro a versão declarada. Formatar muda a apresentação do documento; validar verifica sua estrutura. Isso não testa se o serviço publicado cumpre o contrato.

Por que usar este Validador OpenAPI?

Veja as definições junto das operações que dependem delas.

Parâmetros no contexto da operação

O Validador OpenAPI organiza as operações por caminho de requisição. Ao expandir uma entrada, você vê parâmetros herdados, corpo, respostas, servidores e segurança. A busca reduz a visualização, enquanto a exportação mantém todas as operações.

Um documento estruturado se divide em três cartões de endpoints com marcadores coloridos de método.

Referências pendentes ficam visíveis

JSON Pointer locais são verificados no documento informado. Destinos ausentes geram erros e modelos recursivos continuam como referências. Dependências externas recebem um aviso de verificação incompleta, sem simular um resultado totalmente aprovado.

Modelos ligados por referências locais ao lado de uma ligação interrompida com aviso.

Três verificações antes da entrega

01

Leia a versão da especificação

O campo openapi ou swagger seleciona as regras. Em 3.1, um documento que só contém components pode ser válido mesmo sem endpoints de requisição.

  • O exemplo reúne um parâmetro compartilhado e um modelo recursivo.
02

Confira os parâmetros efetivos

A operação substitui o parâmetro herdado que tiver o mesmo nome e local. Revise a lista combinada para entender o que o consumidor realmente precisa enviar.

  • Desative a validação automática para executar com Ctrl/Cmd + Enter.
03

Selecione a saída necessária

A especificação formatada serve para continuar editando. Endpoints gera o inventário JSON completo; Markdown reúne parâmetros e respostas em uma documentação para revisão.

  • Alterar o texto ou as opções desativa a exportação do resultado antigo.

Validação e visualização da especificação

Esquemas correspondentes à versão

A estrutura é verificada com esquemas reais de Swagger 2.0 e OpenAPI 3.0/3.1. Nos modelos 3.1, também são verificadas as formas de palavras-chave padrão do JSON Schema 2020-12, como nomes de tipos.

Coerência de caminhos

IDs de operação repetidos, parâmetros duplicados e parâmetros de caminho ausentes ou não obrigatórios recebem diagnósticos. Metadados como servers e parameters não aumentam a contagem de operações HTTP.

Formatador OpenAPI em JSON e YAML

Escolha recuo de dois ou quatro espaços. A conversão mantém valores, referências e versão, sem migrar automaticamente definitions ou parâmetros de corpo do Swagger 2.0 para OpenAPI 3.

Visualizador OpenAPI e Markdown

Além de explorar os endpoints, você pode gerar um documento com metadados, servidores, parâmetros, corpos e respostas. Descrições são escapadas e blocos de código são delimitados com segurança, sem executar HTML na visualização.

Limites da análise

Um documento por vez
São aceitos Swagger 2.0 e OpenAPI 3.0.x/3.1.x. A versão 3.2 e outras famílias são recusadas. Referências locais apontam para partes desta entrada, não para outros arquivos do computador.
Dependências externas não são buscadas
URLs e caminhos relativos permanecem sem resolução. IDs de recursos, âncoras, referências dinâmicas e dialetos personalizados geram avisos de análise incompleta. Agrupe as dependências primeiro em um ambiente confiável.
YAML é serializado novamente
Comentários e estilos de aspas não são preservados. Use um único documento YAML 1.2 com chaves de texto. Âncoras, aliases, mesclagens, tags personalizadas, chaves duplicadas e números que perderiam precisão são recusados.
O inventário cobre requisições
A lista inclui operações em paths. Webhooks e callbacks passam pela validação estrutural, mas ficam fora do inventário e da análise semântica de caminhos. Exemplos, respostas reais e autenticação exigem testes separados.
Orçamento de processamento
A entrada permite 500.000 caracteres, profundidade 60 e 50.000 nós. O processamento para após 100 diagnósticos, 2.000.000 de caracteres no resultado ou cinco segundos. Divida contratos grandes e revise cada parte.

Dúvidas sobre o Validador OpenAPI

A ferramenta aceita YAML e JSON?

Sim. O formato de saída é independente da entrada. No YAML, escreva chaves como códigos de status em formato de string. Comentários e estilos de apresentação não são mantidos no resultado.

Ela valida toda a especificação?

São verificados estrutura, palavras-chave padrão, referências locais e regras comuns de caminhos. Referências externas e dialetos avançados ficam marcados como não verificados. Respostas reais e exemplos de payload não são testados.

Ela lê arquivos Swagger 2.0?

Sim. O campo swagger: "2.0" ativa as regras dessa versão. A saída continua em Swagger 2.0; mudar JSON para YAML não migra a especificação para OpenAPI 3.

Minha especificação é enviada a um servidor?

Não. A análise acontece no worker do navegador, sem enviar requisições de API ou buscar referências remotas. A entrada não é restaurada automaticamente depois de recarregar a página.

Posso baixar o resultado formatado?

Sim. A visualização escolhida define se o download contém a especificação, o inventário JSON completo ou Markdown. Erros e resultados desatualizados impedem a exportação até uma nova verificação.

Seu documento gerou um resultado inesperado?

Revise o próximo contrato

Use o Validador OpenAPI para conferir a versão, corrigir os diagnósticos e exportar a visualização que sua equipe precisa.

A formatação mantém a versão original da especificação.