SwaggerService

@tsed/swagger

Usage

import { SwaggerService } from "@tsed/swagger";

See /packages/specs/swagger/src/types/services/SwaggerService.ts.

Overview

class SwaggerService {
    protected platform: Platform;
    constructor();
    getOpenAPISpec(conf: SwaggerOS3Settings): Promise<OpenSpec3>;
    getOpenAPISpec(conf: SwaggerOS2Settings): Promise<OpenSpec2>;
    getOpenAPISpec(conf: SwaggerSettings): Promise<OpenSpec2>;
}

protected platform

protected platform: Platform;

getOpenAPISpec

getOpenAPISpec(conf: SwaggerOS3Settings): Promise<OpenSpec3>;

Generate Spec for the given configuration

getOpenAPISpec

getOpenAPISpec(conf: SwaggerOS2Settings): Promise<OpenSpec2>;

getOpenAPISpec

getOpenAPISpec(conf: SwaggerSettings): Promise<OpenSpec2>;