Repolode
Enviar
swagger-api

swagger-api/swagger-ui

O Swagger UI gera documentação interativa de API no navegador a partir de um arquivo de especificação OpenAPI.

Alternativa open source a:PostmanReadMe

Ver no GitHubSite
Estrelas
29,040
Forks
9,250
Issues abertas
1,144
Último commit
anteontem

O que é?

Swagger UI é um conjunto de recursos HTML, JavaScript e CSS que renderiza uma especificação OpenAPI (antes chamada Swagger) como uma página de documentação navegável. Desenvolvedores e consumidores de APIs podem consultar todos os endpoints, seus parâmetros e formatos de resposta, além de enviar requisições de teste diretamente pela página, sem precisar escrever código cliente antes.

O projeto é distribuído em três formatos: o módulo npm swagger-ui, para aplicações de página única com um bundler; swagger-ui-dist, um pacote sem dependências para servidores ou aplicações que não conseguem resolver dependências npm; e swagger-ui-react, um componente React. Também é possível copiar os arquivos HTML, JS e CSS puros da pasta dist para qualquer servidor web.

A versão atual é compatível com OpenAPI 2.0 até 3.2.0, além de várias versões secundárias da série 3.x. Funciona nas versões mais recentes do Chrome, Safari, Firefox e Edge.

Recursos principais

  • 01Renderiza especificações OpenAPI e Swagger como páginas de documentação interativas.
  • 02Permite enviar requisições de teste para endpoints diretamente pelo navegador.
  • 03É distribuído como módulo npm, pacote dist sem dependências e componente React.
  • 04Oferece suporte à autorização OAuth2 e a links diretos para operações específicas.
  • 05Pode ser personalizado por meio de configuração, uma API de plugins e um layout customizado.

Casos de uso

  • Publicar a documentação de referência da API de um serviço backend para consumidores internos ou externos.
  • Permitir que equipes de frontend e mobile explorem uma API antes de escrever código cliente.
  • Incorporar documentação interativa de API em uma aplicação React.
  • Servir documentação estática de API em um servidor que não pode instalar dependências npm.

Tópicos

#openapi#swagger#api-documentation#rest-api#javascript#api-testing#hacktoberfest#oas#open-source#openapi-specification

Perguntas frequentes

O que é swagger-ui?
O Swagger UI gera documentação interativa de API no navegador a partir de um arquivo de especificação OpenAPI. Swagger UI é um conjunto de recursos HTML, JavaScript e CSS que renderiza uma especificação OpenAPI (antes chamada Swagger) como uma página de documentação navegável. Desenvolvedores e consumidores de APIs podem consultar todos os endpoints, seus parâmetros e formatos de resposta, além de enviar requisições de teste diretamente pela página, sem precisar escrever código cliente antes.
swagger-ui é gratuito? Qual é a licença?
swagger-ui é open source sob a licença Apache-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
swagger-ui ainda é mantido?
Manutenção ativa. O último commit de swagger-ui foi em 16 de out. de 2026.
Para que posso usar swagger-ui?
Publicar a documentação de referência da API de um serviço backend para consumidores internos ou externos. Permitir que equipes de frontend e mobile explorem uma API antes de escrever código cliente. Incorporar documentação interativa de API em uma aplicação React. Servir documentação estática de API em um servidor que não pode instalar dependências npm.
Onde consigo swagger-ui?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/swagger-api/swagger-ui

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados