如果您目前正在使用 @nestjs/swagger@3.*
,请注意版本 4.0 中的以下重大/API 更改。
重大更改
以下装饰器已更改/重命名:
@ApiModelProperty
现在是@ApiProperty
@ApiModelPropertyOptional
现在是@ApiPropertyOptional
@ApiResponseModelProperty
现在是@ApiResponseProperty
@ApiImplicitQuery
现在是@ApiQuery
@ApiImplicitParam
现在是@ApiParam
@ApiImplicitBody
现在是@ApiBody
@ApiImplicitHeader
现在是@ApiHeader
@ApiOperation({{ '{' }} title: 'test' {{ '}' }})
现在是@ApiOperation({{ '{' }} summary: 'test' {{ '}' }})
@ApiUseTags
是现在为@ApiTags
DocumentBuilder
重大更改(更新了方法签名):
addTag
addBearerAuth
addOAuth2
setContactEmail
现在是setContact
setHost
已被删除setSchemes
已被删除(改用addServer
,例如addServer('http://')
)
新方法
已添加以下方法:
addServer
addApiKey
addBasicAuth
addSecurity
addSecurityRequirements