Skip to content

tsoa-next / tsoa-next / SpecGenerator

Interface: SpecGenerator

Defined in: packages/runtime/src/decorators/specPath.ts:24

Describes the runtime contract needed to rebuild an OpenAPI document on demand.

Methods

getSpecObject()

ts
getSpecObject(): Promise<Spec>;

Defined in: packages/runtime/src/decorators/specPath.ts:25

Returns

Promise<Spec>


getSpecString()

ts
getSpecString(format): Promise<string>;

Defined in: packages/runtime/src/decorators/specPath.ts:26

Parameters

format

SpecDocumentFormat

Returns

Promise<string>

TypeScript-first OpenAPI generation, route generation, and runtime validation.