Skip to main content

api-openapi-express

@rtorcato/api-openapi-express mounts API documentation UIs as Express routers. Each function serves the rendered HTML at / and the raw spec at /openapi.json.

Install​

pnpm add @rtorcato/api-openapi-express express

express is a peer dependency (^4.18 || ^5).

serveApiDocs (Scalar)​

Mounts Scalar API Reference.

import { serveApiDocs } from '@rtorcato/api-openapi-express'
import { spec } from './spec.js'

app.use('/api-docs', serveApiDocs(spec, { title: 'My API', theme: 'deepSpace' }))
// GET /api-docs          → Scalar UI
// GET /api-docs/openapi.json → raw spec

serveSwaggerDocs (Swagger UI)​

Mounts Swagger UI.

import { serveSwaggerDocs } from '@rtorcato/api-openapi-express'
import { spec } from './spec.js'

app.use('/swagger', serveSwaggerDocs(spec, { title: 'My API' }))
// GET /swagger          → Swagger UI
// GET /swagger/openapi.json → raw spec

Options​

Both functions accept the same options as their counterparts in api-openapi — serveApiDocs takes ScalarOptions, serveSwaggerDocs takes SwaggerOptions.