demystify

Demystify is an innovative suite of tools designed to simplify the process of generating OpenAPI specifications in real time from live network traffic or HTTP Archive (HAR) files. This powerful toolset allows developers to accurately map out API behaviors without needing manual input, making it a time-saving asset for any API-related development.

Key Features

• Real-Time Processing: Capture and generate OpenAPI 3.1 specifications instantly as network requests are made, providing immediate insights into API behavior.
• Versatile Tools: Demystify is available through a desktop application featuring a built-in proxy, a browser extension for seamless integration with web development, a command-line interface (CLI) for efficient file handling, and a library for embedding into other applications.
• Automated Detection: The tool automatically identifies path parameters and captures a comprehensive range of data, including request and response headers, bodies, and cookie information, across different status codes and MIME types.

How It Works

The desktop app captures network traffic and analyzes HTTP requests to automatically generate OpenAPI specifications. The browser extension operates directly within browser DevTools, allowing for real-time updates of specifications as API calls are made.

Example Usage of CLI Tool

npx demystify --input <somefile.har>

This command will generate OpenAPI specifications for the provided HAR file.

Example Usage of Library

import { Representor } from "demystify-lib";
const representor = new Representor();
representor.upsert(/* harEntry */);
const doc = representor.rest.generate();

For more information, visit the Demystify GitHub page or explore the demo.
With Demystify, simplifying API design and enhancing development productivity is now more accessible than ever.