OpenAPI AutoSpec

Need last-minute docs? Quickly capture API behavior with a server proxy that automatically generates OpenAPI specifications in real-time from any locally running website or service.

OpenAPI AutoSpec is a local server proxy that generates new OpenAPI specifications from network requests. When running, it will connect your local HTTP traffic to the proxy. Once that happens, it will automatically convert network traffic into the specification.

What is OpenAPI?

OpenAPI specifications provide a standardized description of an API's expected requests and responses, making APIs easier to understand and integrate with. Governed by the OpenAPI Initiative and the Linux Foundation, they are the modern standard for documenting RESTful APIs.

Key Feature:

• Generate OpenAPI 3.0 specifications automatically for any local website or application
• Capture and document new requests & responses, including headers, bodies, and query parameters
• Review generated specifications in real-time on your terminal and download them with ease
• Export your OpenAPI file for sharing
• Ignores static file URLs: .js, .css, .svg, .png, .jpeg, .ico.

How to use OpenAPI AutoSpec:

Start the server, it generates a link for you to use, and then use the new link from the proxy server to catch traffic on a target server.

To generate the document you want: visit pages, fill out forms/all the fields or data you wish to track, and perform the actions you want to document from your APIs.

For more information on getting documentation from a full-stack server versus both frontend and backend servers - use this reference.