从捕获的API流量引导生成OpenAPI规范,在客户端或测试自动化开始之前
利用mitmproxy2swagger将捕获的mitmproxy流量或HAR导出文件转换为初步的OpenAPI文档,智能体可后续优化、验证并交付给下游工具。当API已存在但合同缺失,且需要在生成客户端、模拟、测试或可审查文档前获得具体规范时调用。
前提条件
Python 3 和 pip,以及 mitmproxy 流量捕获文件或来自浏览器 DevTools 的 HAR 导出文件
安装
使用与您环境匹配的上游安装或设置路径:
- $ pip install mitmproxy2swagger
- $ git clone [email protected]:alufers/mitmproxy2swagger.git
- $ docker build -t mitmproxy2swagger .
- $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i <mitmproxy_flow_路径> -o <输出模式路径> -p <API前缀>
来自上游的要求和注意事项:
- poetry 用于依赖管理
基本用法或入门说明:
-
首先需要 python3 和 pip3。
-
bash
-
... 或 ...
-
摘自上游文档:https://raw.githubusercontent.com/alufers/mitmproxy2swagger/HEAD/README.md