macklinkachorn / openapi-autospec

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.

About

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.

Features:

• Generate OpenAPI 3.1 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

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js. Node.js 0.10 or higher is required.

Installation steps: npm install command:

$ npm install openapi-autospec

To start the server:

$ node proxy.js

This will initiate the server that listens to network requests from your locally running websites, automatically documenting their API interactions.

Usage

Once the server is running, it will automatically begin documenting the API behavior of your local web applications. The documentation process is based on the network requests observed, so you don't need to do any additional setup within your applications.

The server provides real-time printouts of the generated OpenAPI specifications. From here:

• Fill out all fields you wish to be documented for forms
• Export the OpenAPI specification for external use or sharing
• You should find and replace all instances of ‘localhost’ or ‘127.0.0.1:8000’ in the exported doc with your actual website
• Filter hosts and parameterize paths to fine-tune the documentation properly for server stubs
• Restart the documentation process at any time to refresh the generated specifications

Roadmap

Want an easy way to automatically build and manage your SDKs, Zapier/Make integrations, Docs, Webhooks, RPA plugins, and custom plugins to marketplaces like Salesforce, Zoom, GSuite all in one spot while getting your app AI-agent ready? Contact us. We can custom tailor this and more.

As for the repo:

• Path parameterization tools
• HTTPS support
• Run on GCP, AWS, Azure, Docker, and Kubernetes

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.

Community

Join our Discord! We are here to answer questions and help you get the most out of our OpenAPI tool.

Contributing

We welcome community contributions. For guidelines, refer to our CONTRIBUTING.md.

Shoutouts to Awesome API DevTools and OpenAPI Devtools.