Exiba uma definição OpenAPI ou Swagger localmente

Cole uma definição autocontida para explorar operações, corpos de requisição, respostas e schemas sem enviá-la a lugar nenhum. O visualizador verifica a versão e resolve cada referência dentro do documento colado antes de renderizar.

VISUALIZADOR LOCALSwagger UI 5.32.14OpenAPI 3.x · Swagger 2.0Execução de endpoints desativada
Sua definição é renderizada neste navegador. Cada $ref precisa ser resolvido dentro do documento colado; URLs externas, caminhos de arquivo relativos, chamadas de validação e requisições Try it out ficam bloqueados, e nenhuma requisição sai do navegador.
Documento OpenAPI ou Swagger
Prévia da documentação
Cole um documento OpenAPI ou Swagger e renderize a documentação local.

Revise a documentação sem ativar um cliente de API

Este visualizador serve para revisar o contrato de forma visual: ele nunca envia requisições, não guarda autorizações, não baixa definições remotas nem resolve referências fora do documento colado. Use o Explorer quando quiser gerar uma requisição a partir de detalhes copiados.

Como renderizar uma definição de API localmente

Cole uma definição OpenAPI 3.x ou Swagger 2.0 e leia como documentação do Swagger UI sem enviá-la a lugar nenhum. A análise, a verificação e a renderização acontecem nesta aba, o Try it out fica desligado e a contagem de requisições durante a renderização é zero.

O visualizador verifica a definição antes. A raiz precisa ter uma versão aceita, cada $ref precisa apontar para dentro do mesmo documento, e todas essas referências precisam ser resolvidas; qualquer outro caso é avisado na linha de status em vez de deixar uma página pela metade.

  1. Cole uma definição JSON ou YAML, ou clique em Carregar exemplo para ver uma API de notas com duas operações.
  2. Clique em Renderizar documentação local. JSON e YAML são lidos no navegador; um problema de YAML indica a linha e um de JSON indica a posição.
  3. Expanda uma operação para ler parâmetros, corpo da requisição, respostas e schemas. Aqui as operações são apenas documentação: nenhum botão de requisição é exibido.
  4. Limpar esvazia o campo e a prévia. Depois de renderizar, editar o documento esmaece a prévia e a marca como pertencente ao documento anterior até você renderizar de novo.

O que o visualizador verifica antes de renderizar

O que a definição pode conter

Raízes OpenAPI 3.x e Swagger 2.0 são aceitas; o campo de versão é obrigatório e openapi: 4.x é recusado com uma mensagem em vez de uma página de erro do Swagger UI. Tanto o JSON quanto o subconjunto de YAML usado por arquivos OpenAPI são analisados: mapas, sequências, coleções em linha [] e {}, chaves entre aspas, comentários, escalares de bloco | e > com chomping, âncoras e aliases (&nome / *nome) e as tags !!str, !!int, !!float, !!bool e !!null. Um segundo documento após --- é informado como erro em vez de ser fundido ao primeiro.

Referências e requisições de rede

Só há suporte a referências dentro do documento colado. ./schemas/a.json, a.yaml, caminhos relativos e URLs http(s) são recusados antes da renderização, e a mensagem indica a propriedade que os contém, então uma definição que aponta para um arquivo relativo é avisada em vez de pedi-lo em silêncio a este site. Referências locais como #/components/schemas/Note são resolvidas contra o documento colado, e uma referência a um nó inexistente é avisada na hora em vez de falhar ao expandir a operação.

Como ler o resultado

A prévia lista as operações com parâmetros, corpos de requisição, respostas e schemas no layout base do Swagger UI, sem botão Try it out e sem formulário de autorização. Medido nesta versão: o exemplo incluído renderiza duas operações, uma definição com 200 operações leva cerca de um quarto de segundo e renderizar o mesmo documento duas vezes não duplica a prévia.

Ferramentas recentes: