Pular para o conteúdo

Validador OpenAPI

Verifique um documento OpenAPI 3.0, 3.1 ou 3.2, ou Swagger 2.0, em YAML ou JSON e obtenha um resumo dos endpoints e schemas. O validador verifica os campos obrigatórios, os modelos de caminho em relação aos parâmetros de caminho, os locais dos parâmetros, os códigos de resposta, IDs de operação duplicados e cada $ref local, e lista cada problema com sua localização.

Redefinir

Perguntas frequentes

O que o validador verifica?

Ele verifica a versão de openapi ou swagger, info.title e info.version, se os caminhos começam com uma barra, se cada {parameter} em um caminho tem um parâmetro de caminho obrigatório correspondente e vice-versa, os nomes e locais dos parâmetros, os códigos de status e descrições das respostas, parâmetros duplicados, valores de operationId duplicados e se cada $ref local aponta para algo no documento.

Esta é uma validação completa do Schema JSON da especificação?

Não. Ele verifica as regras estruturais acima, que detectam a maioria dos erros em documentos escritos manualmente, mas não valida cada campo em relação ao meta-schema oficial nem verifica o conteúdo dos seus schemas.

O que o resumo mostra?

A especificação e a versão API, o título, uma tabela com cada endpoint, seu método, caminho, operationId, resumo e códigos de resposta, além dos nomes dos schemas em components.schemas ou, no Swagger 2.0, em definitions.

As referências externas são seguidas?

Não. Referências a outros arquivos ou URLs não são buscadas nem relatadas. Apenas referências que começam com # são resolvidas dentro do documento colado.

Qual é a diferença entre erros e avisos?

Erros violam uma regra da especificação, por exemplo, uma descrição de resposta ausente ou um parâmetro de caminho que não foi declarado. Avisos apontam para situações permitidas, mas geralmente não intencionais, como uma operação GET com corpo de solicitação ou um documento sem nenhum operationId.

O OpenAPI 3.1 muda o que é obrigatório?

Sim. No OpenAPI 3.1 e 3.2, uma operação não precisa mais de um objeto responses, e um documento pode ter webhooks ou components em vez de paths. O validador aplica essas regras quando o campo openapi começa com 3.1 ou 3.2.

Sobre OneClick Pro

OneClick Pro é uma coleção gratuita com mais de 150 ferramentas da Web para o trabalho cotidiano: converter imagens e unidades, formatar e validar código, verificar domínios e SEO, e trabalhar com textos, datas e números. Todas as ferramentas funcionam sem registro ou assinatura, e o que você digita é usado apenas para calcular o resultado e nunca é armazenado. Use o serviço como uma caixa de ferramentas para tarefas pontuais ou salve nos favoritos as ferramentas que você usa todos os dias.