swagger ui
v5.18.2 Released!
A UI da Swagger permite a qualquer pessoa - seja sua equipe de desenvolvimento ou seus consumidores finais - visualize e interaja com os recursos da API sem ter nenhuma lógica de implementação em vigor. É gerado automaticamente a partir da sua especificação OpenAPI (anteriormente conhecida como Swagger), com a documentação visual facilitando a implementação de back -end e o consumo lateral do cliente.
? Deseja marcar uma contribuição fácil de fonte aberta? Confira nosso bom rótulo da primeira edição.
? ️ Procurando a versão mais antiga da interface do usuário swagger? Consulte a filial 2.x.
Este repositório publica três módulos diferentes da NPM:
Sugerimos fortemente que você use swagger-ui em vez de swagger-ui-dist se você estiver construindo um aplicativo de uma página, já que swagger-ui-dist é significativamente maior.
Se você estiver procurando por um simples html/js/css, faça o download da versão mais recente e copie o conteúdo da pasta /dist para o seu servidor.
A especificação OpenAPI passou por 5 revisões desde a criação inicial em 2010. A compatibilidade entre a interface do usuário do Swagger e a especificação do OpenAPI é a seguinte:
| Versão da interface do usuário de swagger | Data de lançamento | Compatibilidade do OpenApi Spec | Notas |
|---|---|---|---|
| 5.0.0 | 2023-06-12 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | Tag v5.0.0 |
| 4.0.0 | 2021-11-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v4.0.0 |
| 3.18.3 | 2018-08-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Tag v3.18.3 |
| 3.0.21 | 2017-07-26 | 2.0 | Tag v3.0.21 |
| 2.2.10 | 2017-01-04 | 1.1, 1.2, 2.0 | Tag v2.2.10 |
| 2.1.5 | 2016-07-20 | 1.1, 1.2, 2.0 | Tag v2.1.5 |
| 2.0.24 | 2014-09-12 | 1.1, 1.2 | Tag v2.0.24 |
| 1.0.13 | 2013-03-08 | 1.1, 1.2 | Tag v1.0.13 |
| 1.0.1 | 2011-10-11 | 1.0, 1.1 | Tag v1.0.1 |
O Swaggerui usa lenço para coletar análises de instalação anonimizadas. Essas análises ajudam a apoiar os mantenedores desta biblioteca e executam apenas durante a instalação. Para optar por não participar, você pode definir o campo scarfSettings.enabled como false no package.json do seu projeto:
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
Como alternativa, você pode definir a variável de ambiente SCARF_ANALYTICS como false como parte do ambiente que instala seus pacotes NPM, por exemplo, SCARF_ANALYTICS=false npm install .
Você precisará de JDK da versão 7 ou superior, conforme instruído aqui https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-sever
Os testes de integração podem ser executados localmente com npm run e2e - verifique se você não está executando um servidor de desenvolvimento ao testar!
A interface do usuário do Swagger trabalha nas mais recentes versões de Chrome, Safari, Firefox e Edge.
Para ajudar na migração, aqui estão os problemas atualmente conhecidos com 3.x. Esta lista será atualizada regularmente e não incluirá recursos que não foram implementados em versões anteriores.
collectionFormat é parcial.Por favor, divulgue quaisquer problemas ou vulnerabilidades relacionados à segurança, enviando um e-mail para [email protected], em vez de usar o rastreador de edição pública.
O Swaggerui está licenciado sob a licença Apache 2.0. O Swaggerui vem com um arquivo de aviso explícito contendo avisos e informações legais adicionais.
