SheepNav
WireQuill

WireQuill

github.com

将真实HTTP流量转化为实时OpenAPI文档

1个月前制作者:Gokhan Ozgezer

关于 WireQuill

WireQuill 是一款革命性的开发者工具,能够将应用程序产生的真实 HTTP 流量自动转化为实时更新的 OpenAPI 3.1 文档。无需手写规范、添加注解、注册账号或依赖云端服务,只需将其作为本地反向代理运行,正常使用你的应用,即可在流量经过时自动捕获端点、参数、请求/响应模式、状态码和认证方案。

核心功能

  • 实时文档生成:随着流量产生,文档即时更新,始终反映应用的真实行为。
  • 本地反向代理:以本地代理方式运行,无需修改应用代码或配置。
  • 保守推断:采用保守的推断策略,确保生成的模式准确可靠。
  • 敏感数据保护:自动对常见敏感值进行脱敏处理,确保示例数据安全。

主要特性

  • 零配置启动:无需复杂设置,即刻开始生成文档。
  • 动态更新:文档随流量动态变化,保持最新状态。
  • 全面覆盖:自动捕获端点、参数、模式、状态码和认证信息。
  • 隐私优先:敏感数据自动脱敏,保护用户隐私。
  • 开源友好:可作为本地工具使用,完全掌控数据。

适用场景

  • API 开发与维护:快速生成和更新 API 文档,减少手动维护成本。
  • 测试与调试:实时查看 API 行为,加速问题定位。
  • 团队协作:为前端、测试或第三方开发者提供准确的 API 参考。
  • 遗留系统文档化:为老项目自动生成缺失的文档。

WireQuill 让 API 文档始终与代码同步,是开发者提升效率的得力助手。

相关工具