swagger ui
v5.18.2 Released!
La interfaz de usuario de Swagger permite que cualquiera, ya sea su equipo de desarrollo o sus consumidores finales, visualice e interactúen con los recursos de la API sin tener ninguna de la lógica de implementación en su lugar. Se genera automáticamente a partir de su especificación OpenAPI (anteriormente conocida como Swagger), con la documentación visual que facilita la implementación de Back End y el consumo del lado del cliente.
? ¿Quiere obtener una contribución fácil de código abierto? Echa un vistazo a nuestra buena etiqueta de primer número.
"¿Buscas la versión anterior de Swagger UI? Consulte la rama 2.x.
Este repositorio publica tres módulos NPM diferentes:
Sugerimos encarecidamente que use swagger-ui en lugar de swagger-ui-dist si está construyendo una aplicación de una sola página, ya que swagger-ui-dist es significativamente más grande.
Si está buscando html/js/css liso, descargue la última versión y copie el contenido de la carpeta /dist a su servidor.
La especificación de OpenAPI ha sufrido 5 revisiones desde la creación inicial en 2010. La compatibilidad entre la interfaz de usuario de Swagger y la especificación de OpenAPI es la siguiente:
| Versión de UI de Swagger | Fecha de lanzamiento | Compatibilidad con especificaciones de OpenAPI | Notas |
|---|---|---|---|
| 5.0.0 | 2023-06-12 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | Etiqueta v5.0.0 |
| 4.0.0 | 2021-11-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Etiqueta V4.0.0 |
| 3.18.3 | 2018-08-03 | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3 | Etiqueta V3.18.3 |
| 3.0.21 | 2017-07-26 | 2.0 | Etiqueta V3.0.21 |
| 2.2.10 | 2017-01-04 | 1.1, 1.2, 2.0 | Etiqueta v2.2.10 |
| 2.1.5 | 2016-07-20 | 1.1, 1.2, 2.0 | Etiqueta v2.1.5 |
| 2.0.24 | 2014-09-12 | 1.1, 1.2 | Etiqueta v2.0.24 |
| 1.0.13 | 2013-03-08 | 1.1, 1.2 | Etiqueta V1.0.13 |
| 1.0.1 | 2011-10-11 | 1.0, 1.1 | Etiqueta V1.0.1 |
Swaggerui utiliza la bufanda para recopilar análisis de instalación anonimizados. Estos análisis ayudan a apoyar a los mantenedores de esta biblioteca y solo se ejecutan durante la instalación. Para optar package.json false participar, puede establecer el campo scarfSettings.enabled
// package.json
{
// ...
"scarfSettings": {
"enabled": false
}
// ...
}
Alternativamente, puede establecer la variable de entorno SCARF_ANALYTICS en false como parte del entorno que instala sus paquetes NPM, por ejemplo, SCARF_ANALYTICS=false npm install .
Necesitará JDK de la versión 7 o más según las instrucciones aquí https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server
Las pruebas de integración se pueden ejecutar localmente con npm run e2e .
Swagger UI funciona en las últimas versiones de Chrome, Safari, Firefox y Edge.
Para ayudar con la migración, aquí están los problemas conocidos actualmente con 3.x. Esta lista se actualizará regularmente y no incluirá características que no se implementaron en versiones anteriores.
collectionFormat es parcial.Divule cualquier problema o vulnerabilidad relacionada con la seguridad enviando un correo electrónico a [email protected], en lugar de utilizar el rastreador de problemas públicos.
Swaggerui tiene licencia bajo la licencia Apache 2.0. Swaggerui viene con un archivo de notificación explícita que contiene avisos e información legales adicionales.
