Guia de uso da ferramenta

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

Fatos principais

Categoria: Validation
Tipos de entrada: textarea
Tipo de saída: html
Cobertura de exemplos: 4
API pronta: Sim

Visão geral

O Validador OpenAPI / Swagger permite verificar a conformidade estrutural de especificações de API nos formatos OpenAPI 3.0/3.1 e Swagger 2.0, identificando erros em campos obrigatórios, referências quebradas, duplicidade de identificadores e inconsistências em componentes.

Quando usar

Antes de publicar ou compartilhar a documentação de uma API REST com desenvolvedores externos.
Ao depurar erros de sintaxe ou referências $ref inválidas em arquivos YAML ou JSON de especificações OpenAPI.
Durante o processo de integração contínua para garantir que as alterações na especificação da API não quebrem o contrato.

Como funciona

1Insira ou cole o código YAML ou JSON da sua especificação OpenAPI ou Swagger no campo de entrada.
2O validador analisa a estrutura do documento, verificando a presença de campos obrigatórios e a validade dos caminhos e métodos HTTP.
3O sistema resolve as referências internas e externas ($ref) e verifica a unicidade dos identificadores de operação (operationId).
4O resultado da validação é exibido instantaneamente, destacando erros estruturais e avisos de conformidade.

Casos de uso

Validação rápida de contratos de API antes de gerar código cliente ou servidor.
Correção de erros de sintaxe e referências circulares ou quebradas em arquivos YAML complexos.
Auditoria de conformidade de esquemas JSON e códigos de resposta HTTP em endpoints de API.

Exemplos

1. Validação de Referências Quebradas em API de E-commerce

Desenvolvedor Backend

Contexto

Um desenvolvedor está atualizando a documentação de uma API de e-commerce em YAML e adicionou novos esquemas de dados.

Problema

A documentação parou de renderizar no Swagger UI devido a um erro de referência $ref não resolvida.

Como usar

Colou o conteúdo do arquivo YAML no campo de texto do validador para identificar a linha exata do erro.

openapi: 3.0.0
info:
  title: E-commerce API
  version: 1.0.0
paths:
  /products:
    get:
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductInvalid'

Resultado

O validador apontou que o componente ProductInvalid não existia na seção de esquemas, permitindo a correção rápida para Product.

2. Correção de operationId Duplicado em API Financeira

Engenheiro de Integrações

Contexto

Uma equipe de engenharia está gerando um SDK automático a partir de um arquivo JSON do Swagger 2.0.

Problema

O gerador de código falha porque existem múltiplos endpoints compartilhando o mesmo identificador de operação.

Perguntas frequentes

Quais versões do OpenAPI são suportadas?

O validador suporta as especificações OpenAPI 3.0, 3.1 e Swagger 2.0.

Posso validar arquivos em formato YAML e JSON?

Sim, a ferramenta aceita especificações estruturadas tanto em formato YAML quanto em JSON.

O que acontece se houver uma referência $ref quebrada?

O validador identificará a referência inválida e apontará o local exato do erro para correção.

Por que a unicidade do operationId é importante?

IDs de operação duplicados causam conflitos na geração de SDKs e na documentação interativa da API.

Meus dados de API são salvos no servidor?

Não, a validação é processada localmente e os dados da sua especificação não são armazenados.

{
  "swagger": "2.0",
  "info": {
    "title": "Finance API",
    "version": "1.0.0"
  },
  "paths": {
    "/accounts": {
      "get": {
        "operationId": "getDetails",
        "responses": { "200": { "description": "OK" } }
      }
    },
    "/transactions": {
      "get": {
        "operationId": "getDetails",
        "responses": { "200": { "description": "OK" } }
      }
    }
  }
}

Validador OpenAPI / Swagger

Executar esta ferramenta

Exemplos compatíveis com esta ferramenta

Continue com ferramentas e temas relacionados

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 Referências Quebradas em API de E-commerce

2. Correção de operationId Duplicado em API Financeira

Perguntas frequentes

Versionamento de API e revisao de breaking changes

Exemplos OpenAPI/Swagger

Exemplos OpenAPI/Swagger

Exemplos de Processamento de Imagem Android Java

Exemplos de Processamento de Imagem Android Kotlin

Validador de Códigos Postais Globais

IBAN & SWIFT Validator

Calculadora de soma de verificação Mod-11

Validador de CEP dos EUA