auto-api-docs

Automatically generate OpenAPI 3.0 / Swagger documentation from Express routes. Zero config needed for basic usage — just pass your Express app and get a full spec.

Installation

npm install auto-api-docs

Quick Start

const express = require('express');
const { serveSpec, serveSwaggerUI } = require('auto-api-docs');

const app = express();

app.get('/api/users', (req, res) => res.json([]));
app.post('/api/users', (req, res) => res.json({}));
app.get('/api/users/:id', (req, res) => res.json({}));

// Serve OpenAPI JSON at /api-docs
app.use(serveSpec('/api-docs', {
  info: { title: 'My API', version: '2.0.0' }
}));

// Serve Swagger UI at /docs
app.use(serveSwaggerUI('/docs', '/api-docs'));

app.listen(3000);
// Visit http://localhost:3000/docs

API

generateSpec(options) → OpenAPI Object

serveSpec(path, options) → Express middleware

serveSwaggerUI(uiPath, specUrl) → Express middleware

License

MIT