Herramienta de código abierto que genera un sitio adaptable de referencia de API, con tres paneles, a partir de definiciones de OpenAPI, Swagger, AsyncAPI o GraphQL.
axnsan12/drf-yasg
Genera especificaciones Swagger/OpenAPI 2.0 reales y documentación interactiva a partir de APIs de Django REST Framework.
- Estrellas
- 3,547
- Forks
- 439
- Issues abiertos
- 218
- Último commit
- hace 28 días
¿Qué es?
drf-yasg inspecciona las vistas y los serializadores de Django REST Framework y genera un esquema OpenAPI 2.0 (Swagger), para que la documentación de la API refleje el código en lugar de tener que mantenerla manualmente. El esquema se puede servir como JSON o YAML, y la biblioteca incluye swagger-ui y ReDoc para consultar la documentación generada directamente desde el proyecto.
La configuración consiste en añadir la aplicación a INSTALLED_APPS y conectar una vista de esquema en urls.py. Se admiten serializadores anidados y hay hooks en cada etapa de la generación de la especificación para personalizarla. Incluye caché y permite validar el esquema de forma opcional con swagger-spec-validator.
El proyecto solo está orientado a OpenAPI 2.0. Sus mantenedores recomiendan drf-spectacular para los proyectos nuevos que necesiten OpenAPI 3.0, y el README señala que es poco probable que drf-yasg incorpore compatibilidad con la versión 3.0.
Funciones clave
- 01Genera especificaciones Swagger/OpenAPI 2.0 a partir de vistas y serializadores de DRF, incluidos los serializadores anidados.
- 02Sirve la especificación como JSON o YAML.
- 03Incluye swagger-ui y ReDoc para consultar la documentación.
- 04Ofrece hooks de personalización en todo el proceso de generación de la especificación.
- 05Admite la validación opcional con swagger-spec-validator e incluye caché de respuestas.
- 06Funciona con URLPathVersioning y NamespaceVersioning.
Casos de uso
- Documentar una API existente de Django REST Framework sin escribir la especificación manualmente.
- Generar un archivo OpenAPI 2.0 para crear código de cliente con swagger-codegen.
- Publicar documentación interactiva de la API para desarrolladores internos o externos desde un proyecto Django.
Temas
Preguntas frecuentes
- ¿Qué es drf-yasg?
- Genera especificaciones Swagger/OpenAPI 2.0 reales y documentación interactiva a partir de APIs de Django REST Framework. drf-yasg inspecciona las vistas y los serializadores de Django REST Framework y genera un esquema OpenAPI 2.0 (Swagger), para que la documentación de la API refleje el código en lugar de tener que mantenerla manualmente. El esquema se puede servir como JSON o YAML, y la biblioteca incluye swagger-ui y ReDoc para consultar la documentación generada directamente desde el proyecto.
- ¿drf-yasg es gratuito? ¿Qué licencia tiene?
- drf-yasg es open source bajo la licencia Other. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿drf-yasg sigue mantenido?
- Mantenimiento activo. El último commit de drf-yasg fue el 9 oct 2026.
- ¿Para qué puedo usar drf-yasg?
- Documentar una API existente de Django REST Framework sin escribir la especificación manualmente. Generar un archivo OpenAPI 2.0 para crear código de cliente con swagger-codegen. Publicar documentación interactiva de la API para desarrolladores internos o externos desde un proyecto Django.
- ¿Dónde consigo drf-yasg?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/axnsan12/drf-yasg
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Biblioteca Java que genera especificaciones OpenAPI a partir de anotaciones del código y API REST de JAX-RS, con compatibilidad con OpenAPI 3.x.
Swagger UI muestra documentación interactiva de API en el navegador a partir de un archivo de especificación OpenAPI/Swagger.
Kit de herramientas OpenAPI/Swagger de código abierto con una referencia interactiva de API, un cliente de API offline-first e integraciones para numerosos frameworks web.
Herramienta de Go que genera documentación de API Swagger 2.0 a partir de anotaciones en los comentarios del código fuente de Go.
Framework web de Python para crear API REST con anotaciones de tipos sobre Django, documentación OpenAPI automática y validación con Pydantic.