alufers/mitmproxy2swagger
Mitmproxy2swagger
mitmproxy2swagger is a tool that transforms captured mitmproxy network traffic into structured OpenAPI schemas for reverse-engineering REST APIs. It functions as an OpenAPI schema converter and network traffic documentation utility, extracting API endpoints and data structures from captured network packets to create formal technical references.
The tool enables the reconstruction of undocumented APIs by converting intercepted HTTP request and response patterns into specifications. It supports merging multiple traffic capture files into a single schema to incrementally expand an API map and utilizes templates to filter specific network paths for the final output.
The system employs heuristic-based type inference to determine data structures and pairs matching network transactions to integrate concrete request and response examples into the generated documentation. These capabilities automate the conversion of raw network traffic analysis into standardized API definitions.
Features
- Traffic-Based Generation - Converts HTTP traffic from flow files into OpenAPI schemas to reverse-engineer REST APIs.
- Schema Mapping - Maps intercepted HTTP properties to the structured fields of the OpenAPI specification format.
- API Documentation Generators - Generates technical specifications for APIs by capturing real-world usage instead of manual writing.
- OpenAPI Specification Generators - Creates structured OpenAPI schemas from captured HTTP flows to automate the documentation of REST endpoints.
- Traffic-to-Specification Conversion - Transforms intercepted network traffic into structured OpenAPI specifications to document API endpoints.
- Traffic Documentation Tools - Extracts API endpoints and data structures from captured network packets to create technical API references.
- Network Traffic Analyzers - Converts raw mitmproxy captures into readable API definitions to analyze request and response patterns.
- Traffic Flow Parsing - Extracts HTTP request and response data from binary capture archives to reconstruct network interactions.
- API Reverse-Engineering Tools - Documents undocumented APIs by converting intercepted HTTP request and response patterns into formal specifications.
- Traffic-Based Reverse Engineering - Reconstructs API documentation from intercepted network traffic to understand how undocumented services work.
- Type Inference Engines - Employs heuristic-based type inference to determine data structures for API parameters by analyzing captured traffic.
- Traffic-to-Schema Conversion - Turns mitmproxy flow files and traffic archives into standardized API documentation with request and response examples.
- Specification Merging - Combines data from multiple capture files into a single schema to incrementally expand an API specification.
- Schema Merging - Combines multiple capture datasets into a single schema to build a comprehensive API map over time.
- URI Pattern Filtering - Uses a predefined list of URI patterns to include or exclude specific endpoints from the final output.
- OpenAPI Example Document Generation - Adds sample headers and body data from captured network traffic to the resulting OpenAPI specification.
- Transaction Pairing - Pairs matching network transactions to generate concrete example bodies and headers for each endpoint.
- Path Filters - Provides templates to select specific network paths to include or ignore in the final API specification.
- REST API Security Tools - Reverse-engineers REST APIs by capturing and analyzing traffic.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
