Effortlessly discover API behaviour with a Chrome extension that automatically generates OpenAPI specifications in real time for any app or website.
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
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 extracteddist
directory - Open a new tab and then select
OpenAPI
in the developer tools (open withcmd+i
orctrl+i
)
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.
Contributing
To develop the project:
npm install
npm run build
- Nav