Swag Doc
SwagDoc genera automáticamente documentación Swagger/OpenAPI a partir de su tráfico API sin requerir cambios en el código.
Listado en categorías:
ProductividadHerramientas de desarrolloCategorías
Descripción
SwagDoc genera automáticamente documentación Swagger/OpenAPI a partir del tráfico de tu API sin requerir cambios en el código. Captura y analiza las solicitudes y respuestas HTTP como un proxy para inferir la estructura de la API, los tipos de datos y los esquemas, haciendo que la documentación de la API sea sin esfuerzo.
Cómo usar Swag Doc?
Para usar SwagDoc, configúralo como un proxy frente a tu API ejecutando el comando 'swagdoc proxy --port 8080 --target http://yourapiserver.com'. Esto iniciará un servidor proxy que captura el tráfico para la documentación. Después de capturar el tráfico, genera la documentación Swagger/OpenAPI usando 'swagdoc generate --output swagger.json'.
Características principales de Swag Doc:
1️⃣
Actúa como un proxy para capturar el tráfico de la API
2️⃣
Analiza las solicitudes y respuestas HTTP para inferir la estructura de la API
3️⃣
Detecta automáticamente los tipos de datos, parámetros y esquemas de respuesta
4️⃣
Genera documentación OpenAPI/Swagger basada en el tráfico observado
5️⃣
No se requieren cambios en el código de tu API existente
Por qué podría ser usado Swag Doc?
| # | Caso de Uso | Estado | |
|---|---|---|---|
| # 1 | Documentar automáticamente APIs sin modificar el código | ✅ | |
| # 2 | Generar fácilmente especificaciones OpenAPI para APIs existentes | ✅ | |
| # 3 | Organizar la documentación de la API en grupos lógicos basados en las rutas de URL | ✅ | |
Desarrollado por Swag Doc?
SwagDoc es desarrollado por una comunidad de colaboradores y es de código abierto, lo que permite la colaboración y mejoras de desarrolladores de todo el mundo.