class OpenApiGenerator
Since 0.1.0

Generates OpenAPI 3.1 documents from route information.

Constructors

OpenApiGenerator(options: OpenApiGeneratorOptions)

Creates a new OpenAPI generator.

Parameters

Generator options

Methods

addSchema(
name: string,
schema: unknown
): void

Registers a named schema for deduplication.

generate(routes: readonly RouteInfo[]): OpenApiDocument

Generates an OpenAPI document from routes.

Usage

import { OpenApiGenerator } from "openapi-plugin/src/index.ts";