Swag Doc
automatically generate swagger documentation from api.
Listed in categories:
ProductivityDeveloper ToolsAPI
Description
SwagDoc automatically generates Swagger/OpenAPI documentation from your API traffic without requiring any code changes. It captures and analyzes HTTP requests and responses as a proxy to infer API structure, data types, and schemas, making API documentation effortless.
How to use Swag Doc?
To use SwagDoc, set it up as a proxy in front of your API by running the command 'swagdoc proxy --port 8080 --target http://yourapiserver.com'. This will start a proxy server that captures traffic for documentation. After capturing traffic, generate the Swagger/OpenAPI documentation using 'swagdoc generate --output swagger.json'.
Core features of Swag Doc:
1️⃣
Acts as a proxy to capture API traffic
2️⃣
Analyzes HTTP requests and responses to infer API structure
3️⃣
Automatically detects data types, parameters, and response schemas
4️⃣
Generates OpenAPI/Swagger documentation based on observed traffic
5️⃣
No code changes required to your existing API
Why could be used Swag Doc?
| # | Use case | Status | |
|---|---|---|---|
| # 1 | Automatically document APIs without modifying code | ✅ | |
| # 2 | Easily generate OpenAPI specifications for existing APIs | ✅ | |
| # 3 | Organize API documentation into logical groups based on URL paths | ✅ | |
Who developed Swag Doc?
SwagDoc is developed by a community of contributors and is open-source, allowing for collaboration and improvements from developers around the world.