AndrewWalsh/openapi-devtools
Openapi Devtools
openapi-devtools es una extensión de navegador y generador de especificaciones OpenAPI que captura el tráfico de red para documentar automáticamente las estructuras de API de sitios web y aplicaciones. Funciona como un capturador de tráfico HTTP y una herramienta de documentación basada en navegador, mapeando solicitudes de red en tiempo real a especificaciones de API estandarizadas.
La herramienta permite la ingeniería inversa de API al interceptar el tráfico HTTP saliente y utilizar una fusión basada en heurística para combinar encabezados, cuerpos y parámetros de múltiples solicitudes en definiciones de endpoints unificadas. Estas definiciones capturadas pueden visualizarse como documentación legible por humanos dentro del navegador o exportarse como archivos descargables y cadenas compartibles.
El proyecto cubre el flujo de trabajo completo de mapeo de solicitudes de red, desde la generación de especificaciones del lado del cliente y la persistencia basada en estado hasta la exportación final de la definición de la API.
Features
- OpenAPI Specification Generators - Automatically generates OpenAPI specifications by capturing real-time network traffic from a browser.
- API Endpoint Merging - Identifies overlapping patterns in paths and parameters to merge multiple request instances into one API definition.
- Client-Side Spec Generation - Transforms intercepted network metadata into a structured OpenAPI format using a local JavaScript engine.
- Network Traffic Captures - Records headers and payloads from real-time network requests to build unified API endpoint definitions.
- API Reverse-Engineering Tools - Analyzes network traffic of websites to reconstruct internal API structures and endpoint definitions.
- Traffic-to-Spec Mapping - Records and merges real-time browser traffic into a unified set of API endpoint definitions.
- Heuristic Request Merging - Combines headers, bodies, and parameters from multiple requests into unified endpoint definitions.
- Content Script Injection Architectures - Injects tracking scripts into active web pages to monitor network traffic without modifying application code.
- Network Request Interception - Captures outbound HTTP traffic by hooking into browser-level network events.
- Live API Documentation Generators - Converts live HTTP requests into standardized specifications to document undocumented or legacy APIs.
- API Definition Exporters - Provides the ability to export extracted API specifications as downloadable files or shareable strings.
- API Documentation Tools - Provides a browser-based interface for visualizing captured network requests as human-readable API documentation.
- Browser-Based Visualizers - Renders captured network data into a human-readable documentation format for review within the browser.
- Request Export Utilities - Saves captured API definitions as downloadable files or shareable strings for external reuse.
- JSON to Page Rendering - Converts raw OpenAPI JSON specifications into a rendered visual interface of web components.
- API Specification Tools - Generates API specifications directly from browser traffic.
