Swag Doc
SwagDoc自动从您的API流量生成Swagger/OpenAPI文档，无需代码更改。
列在类别中:
生产力开发工具类别
描述
SwagDoc 自动生成 Swagger/OpenAPI 文档，无需对您的 API 进行任何代码更改。它作为代理捕获和分析 HTTP 请求和响应，以推断 API 结构、数据类型和模式，使 API 文档变得轻而易举。
如何使用 Swag Doc?
要使用 SwagDoc，请通过运行命令 'swagdoc proxy --port 8080 --target http://yourapiserver.com' 将其设置为您 API 前面的代理。这将启动一个捕获文档流量的代理服务器。在捕获流量后，使用 'swagdoc generate --output swagger.json' 生成 Swagger/OpenAPI 文档。
核心功能 Swag Doc:
1️⃣
充当代理以捕获 API 流量
2️⃣
分析 HTTP 请求和响应以推断 API 结构
3️⃣
自动检测数据类型、参数和响应模式
4️⃣
根据观察到的流量生成 OpenAPI/Swagger 文档
5️⃣
对现有 API 无需代码更改
为什么要使用 Swag Doc?
| # | 使用案例 | 状态 | |
|---|---|---|---|
| # 1 | 在不修改代码的情况下自动记录 API | ✅ | |
| # 2 | 轻松为现有 API 生成 OpenAPI 规范 | ✅ | |
| # 3 | 根据 URL 路径将 API 文档组织成逻辑组 | ✅ | |
开发者 Swag Doc?
SwagDoc 由一群贡献者开发，是开源的，允许来自世界各地的开发者进行协作和改进。