Repolode
Enviar
swagger-api

swagger-api/swagger-ui

Swagger UI genera documentación interactiva de API en el navegador a partir de un archivo de especificación OpenAPI.

Alternativa open source a:PostmanReadMe

Ver en GitHubSitio web
Estrellas
29,040
Forks
9,250
Issues abiertos
1,144
Último commit
anteayer

¿Qué es?

Swagger UI es un conjunto de recursos HTML, JavaScript y CSS que muestra una especificación OpenAPI (antes Swagger) como una página de documentación navegable. Los desarrolladores y consumidores de API pueden ver todos los endpoints, sus parámetros y las estructuras de las respuestas, y enviar solicitudes de prueba directamente desde la página sin tener que escribir primero código cliente.

El proyecto se distribuye en tres formatos: el módulo npm swagger-ui para aplicaciones de una sola página que usan un bundler, swagger-ui-dist, un paquete sin dependencias para servidores o aplicaciones que no pueden resolver dependencias npm, y swagger-ui-react, un componente de React. También se pueden copiar los archivos HTML, JS y CSS sin procesar de la carpeta dist a cualquier servidor web.

La versión actual admite OpenAPI de la 2.0 a la 3.2.0, además de varias versiones menores de la serie 3.x. Funciona con las versiones más recientes de Chrome, Safari, Firefox y Edge.

Funciones clave

  • 01Muestra especificaciones OpenAPI y Swagger en páginas de documentación interactivas.
  • 02Permite enviar solicitudes de prueba a los endpoints directamente desde el navegador.
  • 03Se distribuye como módulo npm, paquete dist sin dependencias y componente de React.
  • 04Admite la autorización OAuth2 y los enlaces directos a operaciones específicas.
  • 05Se puede personalizar mediante configuración, una API de plugins y un diseño personalizado.

Casos de uso

  • Publicar la documentación de referencia de la API de un servicio backend para consumidores internos o externos.
  • Permitir que los equipos de frontend y móviles exploren una API antes de escribir código cliente.
  • Integrar documentación interactiva de API en una aplicación React.
  • Servir documentación estática de API desde un servidor que no puede instalar dependencias npm.

Temas

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

Preguntas frecuentes

¿Qué es swagger-ui?
Swagger UI genera documentación interactiva de API en el navegador a partir de un archivo de especificación OpenAPI. Swagger UI es un conjunto de recursos HTML, JavaScript y CSS que muestra una especificación OpenAPI (antes Swagger) como una página de documentación navegable. Los desarrolladores y consumidores de API pueden ver todos los endpoints, sus parámetros y las estructuras de las respuestas, y enviar solicitudes de prueba directamente desde la página sin tener que escribir primero código cliente.
¿swagger-ui es gratuito? ¿Qué licencia tiene?
swagger-ui es open source bajo la licencia Apache-2.0. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿swagger-ui sigue mantenido?
Mantenimiento activo. El último commit de swagger-ui fue el 16 oct 2026.
¿Para qué puedo usar swagger-ui?
Publicar la documentación de referencia de la API de un servicio backend para consumidores internos o externos. Permitir que los equipos de frontend y móviles exploren una API antes de escribir código cliente. Integrar documentación interactiva de API en una aplicación React. Servir documentación estática de API desde un servidor que no puede instalar dependencias npm.
¿Dónde consigo swagger-ui?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/swagger-api/swagger-ui

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados