從捕獲的 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 <path_to_mitmptoxy_flow> -o <path_to_output_schema> -p <api_prefix>
上游的需求與注意事項:
- poetry 用於相依性管理
基本用法或入門說明:
-
首先您需要 python3 和 pip3。
-
bash
-
... 或其他 ...
-
擷取自上游文件:https://raw.githubusercontent.com/alufers/mitmproxy2swagger/HEAD/README.md