迁移向导

如果你正在使用@nestjs/swagger@3.*，请注意下面在 4.0 版本中对/API 的更改。

突发的变化

以下装饰器已被更改/重命名:

• @ApiModelProperty is now @ApiProperty
• @ApiModelPropertyOptional is now @ApiPropertyOptional
• @ApiResponseModelProperty is now @ApiResponseProperty
• @ApiImplicitQuery is now @ApiQuery
• @ApiImplicitParam is now @ApiParam
• @ApiImplicitBody is now @ApiBody
• @ApiImplicitHeader is now @ApiHeader
• @ApiOperation({ title: 'test' }) is now @ApiOperation({ summary: 'test' })
• @ApiUseTags is now @ApiTags

DocumentBuilder breaking changes (updated method signatures):

• addTag
• addBearerAuth
• addOAuth2
• setContactEmail is now setContact
• setHost has been removed
• setSchemes has been removed (use the addServer instead, e.g., addServer('http://'))

新方法

添加了以下方法:

• addServer
• addApiKey
• addBasicAuth
• addSecurity
• addSecurityRequirements