O que são OpenAPI e Swagger?
OpenAPI (anteriormente Swagger) é a especificação padrão do setor para descrever APIs RESTful. Um documento OpenAPI define endpoints, formatos de requisição e resposta, métodos de autenticação e schemas de dados da API em um arquivo YAML ou JSON legível por máquina. É amplamente usado para documentação de APIs, geração de SDKs de cliente e testes automatizados.
How to use Visualizador de OpenAPI / Swagger
- 1Paste, upload, or enter the openapi, swagger, api, rest, yaml, json input required by the tool.
- 2Adjust any options such as format, mode, output style, size, or validation behavior.
- 3Review the generated result, parsed details, warnings, or converted output in the preview area.
- 4Copy or download the result for a project, document, form, message, or shared file.
Casos de uso comuns
Revisão rápida da documentação da API
Visualize uma especificação de API sem precisar executar um servidor completo do Swagger UI.
Validação de schemas
Confira se os modelos de dados e as definições de endpoints estão corretos antes de gerar código cliente.
Colaboração no design de APIs
Compartilhe e revise designs de APIs colando especificações durante revisões de código ou reuniões de planejamento.
Perguntas frequentes
Há suporte ao OpenAPI 2.0 (Swagger)?
Este visualizador é otimizado para OpenAPI 3.x. Especificações Swagger 2.0 podem funcionar parcialmente, mas alguns campos, como consumes e produces, não são renderizados.
Minha especificação de API é enviada a algum servidor?
Não. Toda a análise e renderização acontece localmente no navegador. Nenhum dado sai do seu dispositivo.
Posso importar uma especificação por URL?
No momento, é necessário colar diretamente o conteúdo da especificação. Copie o YAML ou JSON bruto do arquivo ou da URL e cole-o aqui.