Softonic

Validador OpenAPI YAML

Etapa 1 / 2
Próximo

Cole seu openapi.yaml e o validador verifica as partes que toda spec precisa: um campo de versão, um objeto info com título e versão e um objeto paths. Ele também avisa sobre chaves de caminho sem barra inicial e chaves de operação que não reconhece.

Como validar um arquivo YAML do OpenAPI

  1. 1

    Copie o YAML

    Copie o conteúdo completo do seu `openapi.yaml` ou `swagger.yaml`, mantendo a indentação exatamente como está.

  2. 2

    Cole no campo

    Cole na caixa do documento OpenAPI / Swagger. No YAML, a indentação é a estrutura, então não a redigite nem reformate.

  3. 3

    Execute a validação

    Avance para a etapa de resultados e leia os erros e os avisos.

  4. 4

    Corrija e verifique de novo

    Corrija cada item indicado no seu arquivo, cole a nova versão e execute outra vez.

Por que a indentação importa para o resultado

No YAML, o aninhamento das chaves decide a qual objeto cada campo pertence. Se version estiver no mesmo nível de info em vez de um nível abaixo, o documento continua sendo um YAML legível, mas info.version fica ausente e a verificação reporta isso. O mesmo vale para paths: uma chave de caminho indentada sob info por engano faz o objeto paths de nível superior desaparecer.

Use espaços, não tabulações, e mantenha um recuo consistente, como dois espaços por nível.

Um exemplo prático

openapi: 3.0.3
info:
  title: Pets API
paths:
  /pets:
    get:
      summary: List pets

O campo de versão, info.title e paths estão presentes, e /pets começa com barra e tem get como método conhecido. Falta uma coisa: info.version. O relatório lista:

Achado Tipo
info.version é obrigatório. Erro

Adicione version: 1.0.0 em info, com dois espaços de recuo, e o documento é reportado como estruturalmente válido.

Mantenha os documentos simples para uma leitura confiável

A verificação lê melhor os mapeamentos YAML comuns: linhas chave: valor simples, aninhadas com indentação consistente. Se um documento com recursos avançados de YAML, como âncoras ou blocos de várias linhas, for reportado como ilegível ou mostrar campos ausentes, tente uma cópia JSON da mesma spec para confirmar se o problema está no conteúdo ou na sintaxe YAML.

Um resultado limpo confirma apenas o esqueleto. Ele não resolve links $ref nem verifica schemas.

Um fluxo prático para especificações YAML

Edite em pequenos passos e verifique de novo. Depois de adicionar um caminho novo ou mover um bloco, cole o arquivo outra vez para pegar uma indentação ruim enquanto a mudança ainda está fresca. Quando dividir uma spec grande em vários arquivos, cole a versão combinada, porque esta verificação lê apenas o texto que você fornece e não carrega outros arquivos. Copie do editor, não de uma página renderizada, já que páginas web podem trocar espaços e aspas por caracteres parecidos que alteram a leitura do YAML.

Por fim, lembre que o relatório lista apenas o que a verificação consegue ver. Um resultado limpo em um arquivo YAML significa que o esqueleto de nível superior está correto, não que cada operação, schema ou referência dentro dele esteja.

Perguntas frequentes

Espaços. O YAML não aceita tabulações para indentação, e uma tabulação pode tornar o documento ilegível ou empurrar campos para o nível errado.

Normalmente o campo está indentado no nível errado, então pertence a outro objeto. Compare a indentação dele com a da chave pai.

Esta verificação só procura a presença do campo openapi ou swagger, não o valor, então versões com e sem aspas passam. Colocar "2.0" entre aspas no Swagger continua sendo um bom hábito.

Sim. O documento é lido primeiro como JSON e, se falhar, como YAML, então qualquer um dos formatos funciona no mesmo campo.

Ferramentas relacionadas

Contador de FPS

Meça o FPS do navegador com requestAnimationFrame: suavização, taxa de quadros mínima e máxima, limite de alerta e gráfico opcional. Roda localmente, sem upload nem API.

Gerador de Configuração Webpack

Crie um webpack.config.js para webpack 5 com JavaScript puro, React ou Vue: TypeScript, Babel, CSS ou Sass, imagens, HtmlWebpackPlugin, servidor de desenvolvimento e a linha de npm install.

Conversor de Tamanho de Arquivo

Converta entre bytes, KB, MB, GB, TB e as unidades binárias IEC (KiB, MiB, GiB, TiB), combinando decimal e binário como preferir.

Gerador de textura de ruído

Gere uma textura de ruído em SVG que se repete sem emendas, com opacidade, frequência do grão, tipo de ruído e cor de fundo ajustáveis, e copie o CSS já pronto.

Gerador de Licença

Gere o texto completo de licenças de código aberto com seu nome e ano preenchidos. Abrange licenças MIT, Apache 2.0, GPLv3, BSD-3, MPL-2.0 e CC.

Desofuscador de JavaScript

Desofusque JavaScript minificado ou empacotado com renomeação de variáveis, decodificação de arrays de strings, reversão de achatamento de fluxo de controle e embelezamento.

Ferramenta disponível em outros idiomas

Guias e casos de uso