@nestjs/swagger

@nestjs/swagger

Version 12.0.1
Published 2 days ago
401 kB
7 dependencies
MIT license

Install

npm i @nestjs/swagger

yarn add @nestjs/swagger

pnpm add @nestjs/swagger

Overview

Nest - modern, fast, powerful node.js web framework (@swagger)

Index

Variables

variable DECORATORS

const DECORATORS: {
    API_OPERATION: string;
    API_RESPONSE: string;
    API_PRODUCES: string;
    API_CONSUMES: string;
    API_TAGS: string;
    API_WEBHOOK: string;
    API_CALLBACKS: string;
    API_PARAMETERS: string;
    API_HEADERS: string;
    API_MODEL_PROPERTIES: string;
    API_MODEL_PROPERTIES_ARRAY: string;
    API_SECURITY: string;
    API_EXCLUDE_ENDPOINT: string;
    API_INCLUDE_ENDPOINT: string;
    API_EXCLUDE_CONTROLLER: string;
    API_EXTRA_MODELS: string;
    API_EXTENSION: string;
    API_SCHEMA: string;
    API_DEFAULT_GETTER: string;
    API_LINK: string;
};

variable DECORATORS_PREFIX

const DECORATORS_PREFIX: string;

Functions

function ApiAcceptedResponse

ApiAcceptedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiAmbiguousResponse

ApiAmbiguousResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiBadGatewayResponse

ApiBadGatewayResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiBadRequestResponse

ApiBadRequestResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiBasicAuth

ApiBasicAuth: (name?: string) => ClassDecorator & MethodDecorator;

function ApiBearerAuth

ApiBearerAuth: (name?: string) => ClassDecorator & MethodDecorator;

function ApiBody

ApiBody: (options: ApiBodyOptions) => MethodDecorator;

function ApiCallbacks

ApiCallbacks: (
    ...callbackObject: Array<CallBackObject<any>>
) => MethodDecorator & ClassDecorator;

function ApiConflictResponse

ApiConflictResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiConsumes

ApiConsumes: (...mimeTypes: string[]) => MethodDecorator & ClassDecorator;

function ApiContinueResponse

ApiContinueResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiCookieAuth

ApiCookieAuth: (name?: string) => ClassDecorator & MethodDecorator;

function ApiCreatedResponse

ApiCreatedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiDefaultGetter

ApiDefaultGetter: (
    type: Type<unknown> | Function,
    parameter: string
) => MethodDecorator;

function ApiDefaultResponse

ApiDefaultResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiEarlyhintsResponse

ApiEarlyhintsResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiExcludeController

ApiExcludeController: (disable?: boolean) => ClassDecorator;

function ApiExcludeEndpoint

ApiExcludeEndpoint: (disable?: boolean) => MethodDecorator;

function ApiExpectationFailedResponse

ApiExpectationFailedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiExtension

ApiExtension: (
    extensionKey: string,
    extensionProperties: any
) => (
    target: object | Function,
    key?: string | symbol,
    descriptor?: TypedPropertyDescriptor<any>
) => any;

function ApiExtraModels

ApiExtraModels: (
    ...models: Function[]
) => (
    target: object,
    key?: string | symbol,
    descriptor?: TypedPropertyDescriptor<any>
) => any;

function ApiFailedDependencyResponse

ApiFailedDependencyResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiForbiddenResponse

ApiForbiddenResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiFoundResponse

ApiFoundResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiGatewayTimeoutResponse

ApiGatewayTimeoutResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiGoneResponse

ApiGoneResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiHeader

ApiHeader: (options: ApiHeaderOptions) => MethodDecorator & ClassDecorator;

function ApiHeaders

ApiHeaders: (headers: ApiHeaderOptions[]) => MethodDecorator & ClassDecorator;

function ApiHideProperty

ApiHideProperty: () => PropertyDecorator;

function ApiHttpVersionNotSupportedResponse

ApiHttpVersionNotSupportedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiIAmATeapotResponse

ApiIAmATeapotResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiIncludeEndpoint

ApiIncludeEndpoint: (disable?: boolean) => MethodDecorator;

function ApiInternalServerErrorResponse

ApiInternalServerErrorResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiLengthRequiredResponse

ApiLengthRequiredResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiLink

ApiLink: ({ from, fromField, routeParam }: ApiLinkOptions) => MethodDecorator;

function ApiMethodNotAllowedResponse

ApiMethodNotAllowedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiMisdirectedResponse

ApiMisdirectedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiMovedPermanentlyResponse

ApiMovedPermanentlyResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiNoContentResponse

ApiNoContentResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiNonAuthoritativeInformationResponse

ApiNonAuthoritativeInformationResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiNotAcceptableResponse

ApiNotAcceptableResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiNotFoundResponse

ApiNotFoundResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiNotImplementedResponse

ApiNotImplementedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiNotModifiedResponse

ApiNotModifiedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiOAuth2

ApiOAuth2: (scopes: string[], name?: string) => ClassDecorator & MethodDecorator;

function ApiOkResponse

ApiOkResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiOperation

ApiOperation: (
    options: ApiOperationOptions,
    { overrideExisting }?: { overrideExisting: boolean }
) => MethodDecorator;

function ApiParam

ApiParam: (options: ApiParamOptions) => MethodDecorator & ClassDecorator;

function ApiPartialContentResponse

ApiPartialContentResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiPayloadTooLargeResponse

ApiPayloadTooLargeResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiPaymentRequiredResponse

ApiPaymentRequiredResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiPermanentRedirectResponse

ApiPermanentRedirectResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiPreconditionFailedResponse

ApiPreconditionFailedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiPreconditionRequiredResponse

ApiPreconditionRequiredResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiProcessingResponse

ApiProcessingResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiProduces

ApiProduces: (...mimeTypes: string[]) => MethodDecorator & ClassDecorator;

function ApiProperty

ApiProperty: (options?: ApiPropertyOptions) => PropertyDecorator;

function ApiPropertyOptional

ApiPropertyOptional: (options?: ApiPropertyOptions) => PropertyDecorator;

function ApiProxyAuthenticationRequiredResponse

ApiProxyAuthenticationRequiredResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiQuery

ApiQuery: (options: ApiQueryOptions) => MethodDecorator & ClassDecorator;

function ApiRequestedRangeNotSatisfiableResponse

ApiRequestedRangeNotSatisfiableResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiRequestTimeoutResponse

ApiRequestTimeoutResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiResetContentResponse

ApiResetContentResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiResponse

ApiResponse: (
    options: ApiResponseOptions,
    { overrideExisting }?: { overrideExisting: boolean }
) => MethodDecorator & ClassDecorator;

function ApiResponseProperty

ApiResponseProperty: (
    options?: Pick<
        ApiPropertyOptions,
        'type' | 'example' | 'format' | 'deprecated' | 'enum'
    >
) => PropertyDecorator;

function ApiSchema

ApiSchema: (options?: ApiSchemaOptions) => ClassDecorator;

function ApiSecurity

ApiSecurity: (
    name: string | SecurityRequirementObject,
    requirements?: string[]
) => ClassDecorator & MethodDecorator;

function ApiSeeOtherResponse

ApiSeeOtherResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiServiceUnavailableResponse

ApiServiceUnavailableResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiSwitchingProtocolsResponse

ApiSwitchingProtocolsResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiTags

ApiTags: (
    ...tags: (string | ApiTagOptions)[]
) => MethodDecorator & ClassDecorator;

function ApiTemporaryRedirectResponse

ApiTemporaryRedirectResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiTooManyRequestsResponse

ApiTooManyRequestsResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiUnauthorizedResponse

ApiUnauthorizedResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiUnprocessableEntityResponse

ApiUnprocessableEntityResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiUnsupportedMediaTypeResponse

ApiUnsupportedMediaTypeResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiUriTooLongResponse

ApiUriTooLongResponse: (
    options?: ApiResponseNoStatusOptions
) => MethodDecorator & ClassDecorator;

function ApiWebhook

ApiWebhook: (name?: string) => MethodDecorator;

function DeepPartialType

DeepPartialType: <T>(
    classRef: Type<T>,
    options?: { skipNullProperties?: boolean }
) => Type<DeepPartial<T>>;

function generateSchema

generateSchema: <T = any>(
    target: Type<T>,
    extraSchemas?: Record<string, SchemaObject>
) => { schema: SchemaObject; schemas: Record<string, SchemaObject> };

function getSchemaPath

getSchemaPath: (model: string | Function) => string;

function IntersectionType

IntersectionType: <T extends Type[]>(
    ...classRefs: T
) => Type<UnionToIntersection<ClassRefsToConstructors<T>[number]>>;

function OmitType

OmitType: <T, K extends keyof T>(
    classRef: Type<T>,
    keys: readonly K[]
) => Type<Omit<T, K>>;

function PartialType

PartialType: <T>(
    classRef: Type<T>,
    options?: { skipNullProperties?: boolean }
) => Type<Partial<T>>;

function PickType

PickType: <T, K extends keyof T>(
    classRef: Type<T>,
    keys: readonly K[]
) => Type<Pick<T, K>>;

function refs

refs: (...models: Function[]) => { $ref: string }[];

Classes

class DocumentBuilder

class DocumentBuilder {}

method addApiKey

addApiKey: (options?: SecuritySchemeObject, name?: string) => this;

method addBasicAuth

addBasicAuth: (options?: SecuritySchemeObject, name?: string) => this;

method addBearerAuth

addBearerAuth: (options?: SecuritySchemeObject, name?: string) => this;

method addCookieAuth

addCookieAuth: (
    cookieName?: string,
    options?: SecuritySchemeObject,
    securityName?: string
) => this;

method addExtension

addExtension: (
    extensionKey: string,
    extensionProperties: any,
    location?: ExtensionLocation
) => this;

method addGlobalParameters

addGlobalParameters: (
    ...parameters: Omit<ParameterObject, 'example' | 'examples'>[]
) => this;

method addGlobalResponse

addGlobalResponse: (...respones: ApiResponseOptions[]) => this;

method addOAuth2

addOAuth2: (options?: SecuritySchemeObject, name?: string) => this;

method addSecurity

addSecurity: (name: string, options: SecuritySchemeObject) => this;

method addSecurityRequirements

addSecurityRequirements: (
    name: string | SecurityRequirementObject,
    requirements?: string[]
) => this;

method addServer

addServer: (
    url: string,
    description?: string,
    variables?: Record<string, ServerVariableObject>,
    serverExtraProperties?: Record<string, any>
) => this;

method addTag

addTag: (
    name: string,
    description?: string,
    externalDocs?: ExternalDocumentationObject,
    options?: { summary?: string; parent?: string; kind?: string }
) => this;

method build

build: () => Omit<OpenAPIObject, 'paths'>;

method setBasePath

setBasePath: (path: string) => this;

method setContact

setContact: (name: string, url: string, email: string) => this;

method setDescription

setDescription: (description: string) => this;

method setExternalDoc

setExternalDoc: (description: string, url: string) => this;

method setLicense

setLicense: (name: string, url: string) => this;

method setOpenAPIVersion

setOpenAPIVersion: (version: string) => this;

method setTermsOfService

setTermsOfService: (termsOfService: string) => this;

method setTitle

setTitle: (title: string) => this;

method setVersion

setVersion: (version: string) => this;

class SwaggerModule

class SwaggerModule {}

method createDocument

static createDocument: (
    app: INestApplication,
    config: Omit<OpenAPIObject, 'paths'>,
    options?: SwaggerDocumentOptions
) => OpenAPIObject;

method loadPluginMetadata

static loadPluginMetadata: (
    metadataFn: () => Promise<Record<string, any>>
) => Promise<void>;

method serveDefinitions

protected static serveDefinitions: (
    httpAdapter: HttpServer,
    getBuiltDocument: () => OpenAPIObject,
    options: {
        jsonDocumentUrl: string;
        yamlDocumentUrl: string;
        swaggerOptions: SwaggerCustomOptions;
    },
    serveOptions: { serveJson: boolean; serveYaml: boolean }
) => void;

method serveDocuments

protected static serveDocuments: (
    finalPath: string,
    urlLastSubdirectory: string,
    httpAdapter: HttpServer,
    documentOrFactory: OpenAPIObject | (() => OpenAPIObject),
    options: {
        ui: boolean;
        raw: boolean | Array<'json' | 'yaml'>;
        jsonDocumentUrl: string;
        yamlDocumentUrl: string;
        swaggerOptions: SwaggerCustomOptions;
    }
) => void;

method serveStatic

protected static serveStatic: (
    finalPath: string,
    app: INestApplication,
    customStaticPath?: string
) => void;

method serveSwaggerUi

protected static serveSwaggerUi: (
    finalPath: string,
    urlLastSubdirectory: string,
    httpAdapter: HttpServer,
    getBuiltDocument: () => OpenAPIObject,
    swaggerOptions: SwaggerCustomOptions
) => void;

method setup

static setup: (
    path: string,
    app: INestApplication,
    documentOrFactory: OpenAPIObject | (() => OpenAPIObject),
    options?: SwaggerCustomOptions
) => void;

Interfaces

interface ApiHeaderOptions

interface ApiHeaderOptions extends Omit<ParameterObject, 'in'> {}

property enum

enum?: SwaggerEnumType;

property extensions

extensions?: Record<string, any>;

interface ApiLinkOptions

interface ApiLinkOptions {}

property from

from: Type<unknown> | Function;

property fromField

fromField?: string;

property routeParam

routeParam: string;

interface ApiResponseCommonMetadata

interface ApiResponseCommonMetadata extends Omit<ResponseObject, 'description'> {}

property description

description?: string;

property isArray

isArray?: boolean;

property nullable

nullable?: boolean;

property standardSchema

standardSchema?: StandardSchemaObject;

property status

status?: number | 'default' | '1XX' | '2XX' | '3XX' | '4XX' | '5XX';

property type

type?: Type<unknown> | Function | [Function] | string;

interface ApiResponseExamples

interface ApiResponseExamples {}

property summary

summary: string;

property value

value: ApiResponseExampleValue;

interface ApiResponseSchemaHost

interface ApiResponseSchemaHost extends Omit<ResponseObject, 'description'> {}

property description

description?: string;

property schema

schema: SchemaObject & Partial<ReferenceObject>;

property status

status?: number | 'default' | '1XX' | '2XX' | '3XX' | '4XX' | '5XX';

interface ApiSchemaOptions

interface ApiSchemaOptions extends Pick<SchemaObjectMetadata, 'name'> {}

property description

description?: string;

property name

name?: string;

interface ApiTagOptions

interface ApiTagOptions {}

property kind

kind?: string;

property name

name: string;

property parent

parent?: string;

interface BaseParameterObject

interface BaseParameterObject {}

property allowEmptyValue

allowEmptyValue?: boolean;

property allowReserved

allowReserved?: boolean;

property content

content?: ContentObject;

property deprecated

deprecated?: boolean;

property description

description?: string;

property example

example?: any;

property examples

examples?: Record<string, ExampleObject | ReferenceObject>;

property explode

explode?: boolean;

property required

required?: boolean;

property schema

schema?: SchemaObject | ReferenceObject;

property style

style?: ParameterStyle;

interface ComponentsObject

interface ComponentsObject {}

property callbacks

callbacks?: Record<string, CallbackObject | ReferenceObject>;

property examples

examples?: Record<string, ExampleObject | ReferenceObject>;

property headers

headers?: Record<string, HeaderObject | ReferenceObject>;

property links

links?: Record<string, LinkObject | ReferenceObject>;

property parameters

parameters?: Record<string, ParameterObject | ReferenceObject>;

property requestBodies

requestBodies?: Record<string, RequestBodyObject | ReferenceObject>;

property responses

responses?: Record<string, ResponseObject | ReferenceObject>;

property schemas

schemas?: Record<string, SchemaObject | ReferenceObject>;

property securitySchemes

securitySchemes?: Record<string, SecuritySchemeObject | ReferenceObject>;

interface ContactObject

interface ContactObject {}

property email

email?: string;

property name

name?: string;

property url

url?: string;

interface DiscriminatorObject

interface DiscriminatorObject {}

property mapping

mapping?: Record<string, string>;

property propertyName

propertyName: string;

interface EncodingPropertyObject

interface EncodingPropertyObject {}

property allowReserved

allowReserved?: boolean;

property contentType

contentType?: string;

property explode

explode?: boolean;

property headers

headers?: Record<string, HeaderObject | ReferenceObject>;

property style

style?: string;

interface ExampleObject

interface ExampleObject {}

property description

description?: string;

property externalValue

externalValue?: string;

property summary

summary?: string;

property value

value?: any;

interface ExternalDocumentationObject

interface ExternalDocumentationObject {}

property description

description?: string;

property url

url: string;

interface InfoObject

interface InfoObject {}

property contact

contact?: ContactObject;

property description

description?: string;

property license

license?: LicenseObject;

property termsOfService

termsOfService?: string;

property title

title: string;

property version

version: string;

interface LicenseObject

interface LicenseObject {}

property name

name: string;

property url

url?: string;

interface LinkObject

interface LinkObject {}

property description

description?: string;

property operationId

operationId?: string;

property operationRef

operationRef?: string;

property parameters

parameters?: LinkParametersObject;

property requestBody

requestBody?: any | string;

property server

server?: ServerObject;

interface MediaTypeObject

interface MediaTypeObject {}

property encoding

encoding?: EncodingObject;

property example

example?: any;

property examples

examples?: ExamplesObject;

property schema

schema?: SchemaObject | ReferenceObject;

interface OAuthFlowObject

interface OAuthFlowObject {}

property authorizationUrl

authorizationUrl?: string;

property refreshUrl

refreshUrl?: string;

property scopes

scopes: ScopesObject;

property tokenUrl

tokenUrl?: string;

interface OAuthFlowsObject

interface OAuthFlowsObject {}

property authorizationCode

authorizationCode?: OAuthFlowObject;

property clientCredentials

clientCredentials?: OAuthFlowObject;

property implicit

implicit?: OAuthFlowObject;

property password

password?: OAuthFlowObject;

interface OpenAPIObject

interface OpenAPIObject {}

property components

components?: ComponentsObject;

property externalDocs

externalDocs?: ExternalDocumentationObject;

property info

info: InfoObject;

property openapi

openapi: string;

property paths

paths: PathsObject;

property security

security?: SecurityRequirementObject[];

property servers

servers?: ServerObject[];

property tags

tags?: TagObject[];

property webhooks

webhooks?: WebhooksObject;

interface OperationObject

interface OperationObject {}

property callbacks

callbacks?: CallbacksObject;

property deprecated

deprecated?: boolean;

property description

description?: string;

property externalDocs

externalDocs?: ExternalDocumentationObject;

property operationId

operationId?: string;

property parameters

parameters?: (ParameterObject | ReferenceObject)[];

property requestBody

requestBody?: RequestBodyObject | ReferenceObject;

property responses

responses: ResponsesObject;

property security

security?: SecurityRequirementObject[];

property servers

servers?: ServerObject[];

property summary

summary?: string;

property tags

tags?: string[];

interface ParameterObject

interface ParameterObject extends BaseParameterObject {}

property in

in: ParameterLocation;

property name

name: string;

interface PathItemObject

interface PathItemObject {}

property $ref

$ref?: string;

property delete

delete?: OperationObject;

property description

description?: string;

property get

get?: OperationObject;

property head

head?: OperationObject;

property options

options?: OperationObject;

property parameters

parameters?: (ParameterObject | ReferenceObject)[];

property patch

patch?: OperationObject;

property post

post?: OperationObject;

property put

put?: OperationObject;

property servers

servers?: ServerObject[];

property summary

summary?: string;

property trace

trace?: OperationObject;

interface ReferenceObject

interface ReferenceObject {}

property $ref

$ref: string;

interface RequestBodyObject

interface RequestBodyObject {}

property content

content: ContentObject;

property description

description?: string;

property required

required?: boolean;

interface ResponseObject

interface ResponseObject {}

property content

content?: ContentObject;

property description

description: string;

property headers

headers?: HeadersObject;

property links

links?: LinksObject;

property summary

summary?: string;

interface ResponsesObject

interface ResponsesObject
    extends Record<string, ResponseObject | ReferenceObject | undefined> {}

property default

default?: ResponseObject | ReferenceObject;

interface SchemaObject

interface SchemaObject {}

property 'x-enumNames'

'x-enumNames'?: string[];

property additionalProperties

additionalProperties?: SchemaObject | ReferenceObject | boolean;

property allOf

allOf?: (SchemaObject | ReferenceObject)[];

property anyOf

anyOf?: (SchemaObject | ReferenceObject)[];

property default

default?: any;

property deprecated

deprecated?: boolean;

property description

description?: string;

property discriminator

discriminator?: DiscriminatorObject;

property enum

enum?: any[];

property example

example?: any;

property examples

examples?: any[] | Record<string, any>;

property exclusiveMaximum

exclusiveMaximum?: boolean;

property exclusiveMinimum

exclusiveMinimum?: boolean;

property externalDocs

externalDocs?: ExternalDocumentationObject;

property format

format?: OpenAPIFormat;

property items

items?: SchemaObject | ReferenceObject;

property maximum

maximum?: number;

property maxItems

maxItems?: number;

property maxLength

maxLength?: number;

property maxProperties

maxProperties?: number;

property minimum

minimum?: number;

property minItems

minItems?: number;

property minLength

minLength?: number;

property minProperties

minProperties?: number;

property multipleOf

multipleOf?: number;

property not

not?: SchemaObject | ReferenceObject;

property nullable

nullable?: boolean;

property oneOf

oneOf?: (SchemaObject | ReferenceObject)[];

property pattern

pattern?: string;

property patternProperties

patternProperties?: SchemaObject | ReferenceObject | any;

property properties

properties?: Record<string, SchemaObject | ReferenceObject>;

property readOnly

readOnly?: boolean;

property required

required?: string[];

property title

title?: string;

property type

type?: string | string[];

property uniqueItems

uniqueItems?: boolean;

property writeOnly

writeOnly?: boolean;

property xml

xml?: XmlObject;

interface SecuritySchemeObject

interface SecuritySchemeObject {}

property 'x-tokenName'

'x-tokenName'?: string;

property bearerFormat

bearerFormat?: string;

property description

description?: string;

property flows

flows?: OAuthFlowsObject;

property in

in?: string;

property name

name?: string;

property openIdConnectUrl

openIdConnectUrl?: string;

property scheme

scheme?: string;

property type

type: SecuritySchemeType;

index signature

[extension: `x-${string}`]: any;

interface ServerObject

interface ServerObject {}

property description

description?: string;

property url

url: string;

property variables

variables?: Record<string, ServerVariableObject>;

interface ServerVariableObject

interface ServerVariableObject {}

property default

default: string | boolean | number;

property description

description?: string;

property enum

enum?: string[] | boolean[] | number[];

interface StandardSchemaConversionResult

interface StandardSchemaConversionResult {}

property components

components?: Record<string, any>;

property schema

schema: unknown;

interface SwaggerCustomOptions

interface SwaggerCustomOptions {}

property customCss

customCss?: string;

property customCssUrl

customCssUrl?: string | string[];

property customfavIcon

customfavIcon?: string;

property customJs

customJs?: string | string[];

property customJsStr

customJsStr?: string | string[];

property customSiteTitle

customSiteTitle?: string;

property customSwaggerUiPath

customSwaggerUiPath?: string;

property explorer

explorer?: boolean;

property jsonDocumentUrl

jsonDocumentUrl?: string;

property patchDocumentOnRequest

patchDocumentOnRequest?: <TRequest = any, TResponse = any>(
    req: TRequest,
    res: TResponse,
    document: OpenAPIObject
) => OpenAPIObject | Promise<OpenAPIObject>;

property raw

raw?: boolean | Array<'json' | 'yaml'>;

property swaggerOptions

swaggerOptions?: SwaggerUiOptions;

property swaggerUiEnabled

swaggerUiEnabled?: boolean;

property swaggerUrl

swaggerUrl?: string;

property ui

ui?: boolean;

property url

url?: string;

property urls

urls?: Record<'url' | 'name', string>[];

property useGlobalPrefix

useGlobalPrefix?: boolean;

property validatorUrl

validatorUrl?: string;

property yamlDocumentUrl

yamlDocumentUrl?: string;

interface SwaggerDocumentOptions

interface SwaggerDocumentOptions {}

property autoTagControllers

autoTagControllers?: boolean;

property deepScanRoutes

deepScanRoutes?: boolean;

property exampleMaxDepth

exampleMaxDepth?: number;

property excludeDynamicDefaults

excludeDynamicDefaults?: boolean;

property extraModels

extraModels?: Function[];

property ignoreGlobalPrefix

ignoreGlobalPrefix?: boolean;

property include

include?: Function[];

property linkNameFactory

linkNameFactory?: (
    controllerKey: string,
    methodKey: string,
    fieldKey: string
) => string;

property onlyIncludeDecoratedEndpoints

onlyIncludeDecoratedEndpoints?: boolean;

property operationIdFactory

operationIdFactory?: OperationIdFactory;

property standardSchemaConverter

standardSchemaConverter?: StandardSchemaConverter;

interface TagObject

interface TagObject {}

property description

description?: string;

property externalDocs

externalDocs?: ExternalDocumentationObject;

property kind

kind?: string;

property name

name: string;

property parent

parent?: string;

property summary

summary?: string;

interface XmlObject

interface XmlObject {}

property attribute

attribute?: boolean;

property name

name?: string;

property namespace

namespace?: string;

property prefix

prefix?: string;

property wrapped

wrapped?: boolean;

Type Aliases

type ApiBodyOptions

type ApiBodyOptions = ApiBodyMetadata | ApiBodySchemaHost;

type ApiOperationOptions

type ApiOperationOptions = Partial<OperationObject>;

type ApiParamOptions

type ApiParamOptions = ApiParamMetadata | ApiParamSchemaHost;

type ApiPropertyOptions

type ApiPropertyOptions =
    | ApiPropertyCommonOptions
    | (ApiPropertyCommonOptions & {
          enumName: string;
          enumSchema?: EnumSchemaAttributes;
      });

type ApiQueryMetadata

type ApiQueryMetadata =
    | ApiQueryCommonMetadata
    | ({
          name: string;
      } & ApiQueryCommonMetadata &
          Omit<SchemaObject, 'required'>)
    | ({
          name?: string;
          enumName: string;
          enumSchema?: EnumSchemaAttributes;
      } & ApiQueryCommonMetadata);

type ApiQueryOptions

type ApiQueryOptions = ApiQueryMetadata | ApiQuerySchemaHost;

type ApiResponseMetadata

type ApiResponseMetadata =
    | (ApiResponseCommonMetadata & {
          example?: ApiResponseExampleValue;
      })
    | (ApiResponseCommonMetadata & {
          examples?: {
              [key: string]: ApiResponseExamples;
          };
      });

type ApiResponseNoStatusOptions

type ApiResponseNoStatusOptions =
    | (Omit<ApiResponseCommonMetadata, 'status'> & {
          example?: ApiResponseExampleValue;
      })
    | (Omit<ApiResponseCommonMetadata, 'status'> & {
          examples?: {
              [key: string]: ApiResponseExamples;
          };
      })
    | Omit<ApiResponseSchemaHost, 'status'>;

type ApiResponseOptions

type ApiResponseOptions = ApiResponseMetadata | ApiResponseSchemaHost;

type CallbackObject

type CallbackObject = Record<string, PathItemObject>;

type CallbacksObject

type CallbacksObject = Record<string, CallbackObject | ReferenceObject>;

type ContentObject

type ContentObject = Record<string, MediaTypeObject>;

type DeepPartial

type DeepPartial<T> = T extends object
    ? {
          [P in keyof T]?: DeepPartial<T[P]>;
      }
    : T;

type EncodingObject

type EncodingObject = Record<string, EncodingPropertyObject>;

type ExamplesObject

type ExamplesObject = Record<string, ExampleObject | ReferenceObject>;

type ExtensionLocation

type ExtensionLocation = 'root' | 'info';

type HeaderObject

type HeaderObject = BaseParameterObject;

type HeadersObject

type HeadersObject = Record<string, HeaderObject | ReferenceObject>;

type LinkParametersObject

type LinkParametersObject = Record<string, any>;

type LinksObject

type LinksObject = Record<string, LinkObject | ReferenceObject>;

type OpenAPIFormat

type OpenAPIFormat =
    | 'int32'
    | 'int64'
    | 'float'
    | 'double'
    | 'byte'
    | 'binary'
    | 'date'
    | 'date-time'
    | 'time'
    | 'duration'
    | 'password'
    | 'email'
    | 'idn-email'
    | 'hostname'
    | 'idn-hostname'
    | 'ipv4'
    | 'ipv6'
    | 'uri'
    | 'uri-reference'
    | 'uri-template'
    | 'iri'
    | 'iri-reference'
    | 'uuid'
    | 'json-pointer'
    | 'relative-json-pointer'
    | 'regex'
    | (string & {});

type OperationIdFactory

type OperationIdFactory = (
    controllerKey: string,
    methodKey: string,
    version?: string
) => string;

type ParameterLocation

type ParameterLocation = 'query' | 'header' | 'path' | 'cookie';

type ParameterStyle

type ParameterStyle =
    | 'matrix'
    | 'label'
    | 'form'
    | 'simple'
    | 'spaceDelimited'
    | 'pipeDelimited'
    | 'deepObject';

type PathsObject

type PathsObject = Record<string, PathItemObject>;

type SchemasObject

type SchemasObject = Record<string, SchemaObject>;

type ScopesObject

type ScopesObject = Record<string, any>;

type SecurityRequirementObject

type SecurityRequirementObject = Record<string, string[]>;

type SecuritySchemeType

type SecuritySchemeType = 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';

type StandardJsonSchemaConverter

type StandardJsonSchemaConverter = StandardJSONSchemaV1.Converter;

type StandardSchemaConverter

type StandardSchemaConverter = (
    schema: unknown,
    options: {
        schemaType: 'input' | 'output';
    }
) => StandardSchemaConversionResult | undefined;

type StandardSchemaObject

type StandardSchemaObject = StandardSchemaV1 | StandardJSONSchemaV1;

type WebhooksObject

type WebhooksObject = Record<string, PathItemObject>;

Package Files (40)

Dependencies (7)

Peer Dependencies (6)

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@nestjs/swagger.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@nestjs/swagger)

HTML

<a href="https://www.jsdocs.io/package/@nestjs/swagger"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 1 day ago.
Package analyzed in 5605 ms.
Missing or incorrect documentation? Open an issue for this package.