- mitmproxy से कैप्चर किए गए HTTP ट्रैफ़िक को OpenAPI 3.0 spec में अपने-आप बदलने वाला टूल
- सिर्फ ऐप चलाकर और ट्रैफ़िक कैप्चर करके REST API का reverse engineering किया जा सकता है
- ब्राउज़र DevTools से export की गई HAR फ़ाइलों को प्रोसेस करने की सुविधा जोड़ी गई
- काम करने का तरीका
- mitmproxy (सुझाव: mitmweb का उपयोग करें) के ज़रिए HTTP ट्रैफ़िक कैप्चर करें
- ट्रैफ़िक सेव करने के बाद mitmproxy2swagger चलाने पर यह उसका विश्लेषण करके OpenAPI schema बनाता है
- बने हुए YAML schema में ज़रूरी Path के
ignore: को हटाकर details समायोजित करें
- संशोधित schema के आधार पर mitmproxy2swagger फिर से चलाने पर अंतिम spec बनती है
- बने हुए schema के साथ redoc-cli के जरिए अपने-आप जनरेट की गई HTML documentation फ़ाइल भी उपलब्ध कराई जाती है
4 टिप्पणियां
कमाल है
वाह, आइडिया बहुत अच्छा है~
डेवलपमेंट करते समय अक्सर ऐसे API मिलते हैं जिनका documentation नहीं होता, या जिनका behavior docs और spec से अलग होता है, इसलिए यह काफ़ी मददगार लग रहा है।
API Parrot – HTTP API ऑटोमैटिक रिवर्स इंजीनियरिंग टूल closed source है, इसलिए इस टूल का भी साथ में ज़िक्र हो रहा है
Hacker News की टिप्पणियां भी साथ में देखें: https://news.ycombinator.com/item?id=42572662