Log in
Preview of OpenAPI DevTools

OpenAPI DevTools by Andrew Walsh

Instantly generate API specifications in real time for any app or website. Open the add-on in Firefox developer tools and watch network requests become an OpenAPI specification.

5 (2 reviews)
183 Users
You'll need Firefox to use this extension
Download Firefox and get the extension
Download file
Screenshots
Capture get, post, put, delete, and patch requests.Watch API requests turn into an API spec. All on the browser and strictly on the client, no network requests are sent to any servers.Use the settings menu to set path parameters, export/import state to save or share, configure hosts to record, and inclusion of request and response examples.
About this extension
Instantly generate API specifications in real time for any app or website .

OpenAPI DevTools generates OpenAPI specifications in real time from network requests. Once installed it adds a new tab to Firefox 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 and download with a click
- Export and save a session at any time, or share it with others
Developer comments
OpenAPI DevTools features an algorithm that turns network requests into an API spec. This happens on device. Network requests are not sent to any servers, nor does the tool make any request or have need to.

To access the tool, open Firefox DevTools and find "OpenAPI" listed as a new tab. While DevTools is open and you select "Begin Recording", the tool receives a copy of each network requests in the HAR format. It then captures REST requests and dispatches them to the algorithm.

The algorithm converts these requests into a performant data structure that enables real-time generation of an OpenAPI 3.1 specification. New requests to the same endpoint are merged into the existing one.

You can specify path parameters in the settings menu. For example given the pathname "/api/posts/my-post", clicking on "my-post" will parameterise this part of the pathname, giving "/api/posts/:param2". This means that any request with a pathname matching "/api/posts/<anything>" will be merged into that endpoint.
Rated 5 by 2 reviewers

Star rating saved

5
2
4
0
3
0
2
0
1
0
Permissions and dataLearn more

Required permissions:

  • Extend developer tools to access your data in open tabs
More information
Version
1.5.2
Size
2.43 MB
Last updated
a year ago (26 Mar 2024)
Related Categories
Version History
Add to collection
Report this add-on
Release notes for 1.5.2
Key names of `securitySchemes` now follow the expected regex standard, excluding whitespace.
More extensions by Andrew Walsh