dosyago / openapi-devtools

Effortlessly discover API behaviour with a Chrome extension that automatically generates OpenAPI specifications in real time for any app or website

Effortlessly discover API behaviour with a Chrome extension that automatically generates OpenAPI specifications in real time for any app or website.

Report Bug · Request Feature

About The Project

OpenAPI DevTools is a Chrome extension that generates OpenAPI specifications in real time from network requests. Once installed it adds a new tab to Chrome 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 Redocly and download with a click

(back to top)

Installation

• Download and extract the zip
• 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)

(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.

(back to top)

Contributing

To develop the project:

• npm install
• npm run build
• 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
• You should now see the tool in Chrome DevTools. You can interact it with like a regular page, including inspection of the React app.
• Extensions Reloader is suggested to update the tool after running npm run build and updating the dist directory

(back to top)