AndrewWalsh/openapi-devtools

[!IMPORTANT]
A new and final version of this project is available below. It has been rewritten from scratch and significantly expands the feature set of OpenAPI DevTools.

New features:

• Identifies path parameters automatically
• Is available as a desktop app that uses a proxy (e.g. see mitm2swagger)
• Has a website and command line tool that can generate OpenAPI specifications from HAR files (e.g. har-to-openapi)
• Uses a published library that can generate API specifications for any API in middleware, DevOps integrations, or any environment
• Can generate curl commands, client code, and send API requests via an API client that populates automatically
• Is agnostic to API semantics and may translate into different versions of OpenAPI, or reverse engineer other HTTP-based standards such as GraphQL
• Includes all original features, including the ability to import and export

---> Check out the new version of OpenAPI DevTools here

About The Project

OpenAPI DevTools is a browser extension that generates OpenAPI specifications in real time from network requests. Once installed it adds a new tab to DevTools called OpenAPI. While the tool is open it automatically converts network requests into a specification.

Features:

• Instantly generate an OpenAPI 3.1 specification for any website or application just by using it
• Automatically merges new request & response headers, bodies, and query parameters per endpoint
• Click on a path parameter and the app will automatically merge existing and future matching requests
• View the specification inside the tool using Redoc and download with a click
• Export and save a session at any time, or share it with others

(back to top)

Installation

Download the extension in the Chrome Web Store.

Download the extension in the Firefox Add-on Store.

Otherwise, to install manually:

• Download and extract the dist.zip file in the latest release
• In Chrome, navigate to chrome://extensions
• In the top right enable the Developer mode toggle
• In the top left click Load unpacked and select the extracted dist directory
• Open a new tab and then select OpenAPI in the developer tools (open with cmd+i or ctrl+i)
• Firefox is more challenging. Please use the add-on store.

(back to top)

Usage

The specification will automatically populate based on JSON requests that fire as you browse the web. In the settings menu you can filter hosts and parameterise paths in URLs. Once you do so all matching existing and future requests to that endpoint will be merged. This process is irreversible, but you can clear the specification and restart at any time.

When the same endpoint responds with different data, such as a value that is sometimes a string and sometimes null, the specification for that value will be either string or null. All information is accounted for in the final specification. If you see something missing from a request, trigger a request that contains the missing information.

The settings menu contains several options. Here you can enable real examples in the specification. You can also export the current state of the app as a string, share or store it, and import it later.

(back to top)

What is OpenAPI?

An OpenAPI specification is a description of what an API expects to receive and what it will respond with. It is governed by the OpenAPI Initiative and the Linux Foundation. OpenAPI specifications are the modern standard for RESTful APIs, and systems that have them are far easier to work with.

(back to top)

Contributing

To develop the project:

• npm install
• npm run dev

(back to top)