@midwayjs/swagger

Index

Classes

• Configuration
• SwaggerExplorer
• SwaggerMiddleware

Enumerations

• BodyContentType

Functions

• ApiAcceptedResponse
• ApiBadGatewayResponse
• ApiBadRequestResponse
• ApiBasicAuth
• ApiBearerAuth
• ApiBody
• ApiConflictResponse
• ApiCookieAuth
• ApiCreatedResponse
• ApiDefaultResponse
• ApiExcludeController
• ApiExcludeEndpoint
• ApiExcludeSecurity
• ApiExtension
• ApiExtraModel
• ApiForbiddenResponse
• ApiFoundResponse
• ApiGatewayTimeoutResponse
• ApiGoneResponse
• ApiHeader
• ApiHeaders
• ApiInternalServerErrorResponse
• ApiMethodNotAllowedResponse
• ApiMovedPermanentlyResponse
• ApiNoContentResponse
• ApiNotAcceptableResponse
• ApiNotFoundResponse
• ApiNotImplementedResponse
• ApiOAuth2
• ApiOkResponse
• ApiOperation
• ApiParam
• ApiPayloadTooLargeResponse
• ApiPreconditionFailedResponse
• ApiProperty
• ApiPropertyOptional
• ApiQuery
• ApiRequestTimeoutResponse
• ApiResponse
• ApiResponseProperty
• ApiSecurity
• ApiServiceUnavailableResponse
• ApiTags
• ApiTooManyRequestsResponse
• ApiUnauthorizedResponse
• ApiUnprocessableEntityResponse
• ApiUnsupportedMediaTypeResponse
• getSchemaPath
• renderJSON
• renderSwaggerUIDist
• renderSwaggerUIRemote

Interfaces

• ApiHeaderOptions
• ApiPropertyOptions
• ApiResponseMetadata
• ApiResponseSchemaHost
• AuthOptions
• BaseParameterObject
• ComponentsObject
• ContactObject
• DiscriminatorObject
• EncodingPropertyObject
• ExampleObject
• ExternalDocumentationObject
• InfoObject
• LicenseObject
• LinkObject
• MediaTypeObject
• MixDecoratorMetadata
• OAuthFlowObject
• OAuthFlowsObject
• OpenAPIObject
• OperationObject
• ParameterObject
• PathItemObject
• ReferenceObject
• RequestBodyObject
• ResponseObject
• ResponsesObject
• SchemaObject
• SchemaObjectMetadata
• SecuritySchemeObject
• ServerObject
• ServerVariableObject
• SwaggerOptions
• TagObject
• Type
• XmlObject

Type Aliases

• ApiBodyOptions
• ApiOperationOptions
• ApiParamOptions
• ApiQueryOptions
• ApiResponseOptions
• AuthType
• CallbackObject
• CallbacksObject
• ContentObject
• EncodingObject
• ExamplesObject
• HeaderObject
• HeadersObject
• LinkParametersObject
• LinksObject
• ParameterLocation
• ParameterStyle
• PathsObject
• SchemasObject
• ScopesObject
• SecurityRequirementObject
• SecuritySchemeType
• SwaggerEnumType

Variables

• DECORATORS
• DECORATORS_CLASS_METADATA
• DECORATORS_METHOD_METADATA
• DECORATORS_PREFIX

Type Aliases

ApiBodyOptions

ApiBodyOptions: ApiBodyMetadata | ApiBodySchemaHost

ApiOperationOptions

ApiOperationOptions: Partial<OperationObject>

ApiParamOptions

ApiParamOptions: ApiParamMetadata | ApiParamSchemaHost

ApiQueryOptions

ApiQueryOptions: ApiQueryMetadata | ApiQuerySchemaHost

ApiResponseOptions

ApiResponseOptions: ApiResponseMetadata | ApiResponseSchemaHost

AuthType

AuthType: basic | bearer | cookie | oauth2 | apikey | custom

CallbackObject

CallbackObject: Record<string, PathItemObject>

CallbacksObject

CallbacksObject: Record<string, CallbackObject | ReferenceObject>

ContentObject

ContentObject: Record<string, MediaTypeObject>

EncodingObject

EncodingObject: Record<string, EncodingPropertyObject>

ExamplesObject

ExamplesObject: Record<string, ExampleObject | ReferenceObject>

HeaderObject

HeaderObject: BaseParameterObject

HeadersObject

HeadersObject: Record<string, HeaderObject | ReferenceObject>

LinkParametersObject

LinkParametersObject: Record<string, any>

LinksObject

LinksObject: Record<string, LinkObject | ReferenceObject>

ParameterLocation

ParameterLocation: query | header | path | cookie

ParameterStyle

ParameterStyle: matrix | label | form | simple | spaceDelimited | pipeDelimited | deepObject

PathsObject

PathsObject: Record<string, PathItemObject>

SchemasObject

SchemasObject: Record<string, SchemaObject>

ScopesObject

ScopesObject: Record<string, any>

SecurityRequirementObject

SecurityRequirementObject: Record<string, string[]>

SecuritySchemeType

SecuritySchemeType: apiKey | http | oauth2 | openIdConnect

SwaggerEnumType

SwaggerEnumType: string[] | number[] | (string | number)[] | Record<number, string>

非 open api spec

Variables

constDECORATORS

DECORATORS: { API_EXCLUDE_CONTROLLER: string; API_EXCLUDE_ENDPOINT: string; API_EXCLUDE_SECURITY: string; API_EXTENSION: string; API_EXTRA_MODEL: string; API_HEADERS: string; API_MODEL_PROPERTIES: string; API_MODEL_PROPERTIES_ARRAY: string; API_OPERATION: string; API_PARAMETERS: string; API_RESPONSE: string; API_SECURITY: string; API_TAGS: string } = ...

constDECORATORS_CLASS_METADATA

DECORATORS_CLASS_METADATA: swagger:class_metadata = 'swagger:class_metadata'

constDECORATORS_METHOD_METADATA

DECORATORS_METHOD_METADATA: swagger:method_metadata = 'swagger:method_metadata'

constDECORATORS_PREFIX

DECORATORS_PREFIX: swagger = 'swagger'