キャプチャしたAPIトラフィックからOpenAPIスペックをブートストラップする

キャプチャした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://github.com/alufers/mitmproxy2swagger

• 上流ドキュメントから抽出: https://raw.githubusercontent.com/alufers/mitmproxy2swagger/HEAD/README.md

ドキュメント

• https://github.com/alufers/mitmproxy2swagger

ソース

• Agent Skill Exchange