OpenAPIService
@tsed/openapi-utils
Usage
typescript
import { OpenAPIService } from "@tsed/openapi-utils";See /packages/specs/openapi-utils/src/services/OpenAPIService.ts.
Overview
ts
class OpenAPIService {
protected platform: Platform;
constructor();
getOpenAPISpec(conf: OpenAPI3Settings): Promise<OpenSpec3>;
getOpenAPISpec(conf: Swagger2Settings): Promise<OpenSpec2>;
getOpenAPISpec(conf: OpenApiSettings): Promise<OpenSpec2>;
writeOpenAPISpec(conf: OpenApiSettings): Promise<void>;
}protected platform
ts
protected platform: Platform;getOpenAPISpec
ts
getOpenAPISpec(conf: OpenAPI3Settings): Promise<OpenSpec3>;Generate Spec for the given configuration
getOpenAPISpec
ts
getOpenAPISpec(conf: Swagger2Settings): Promise<OpenSpec2>;getOpenAPISpec
ts
getOpenAPISpec(conf: OpenApiSettings): Promise<OpenSpec2>;writeOpenAPISpec
ts
writeOpenAPISpec(conf: OpenApiSettings): Promise<void>;