Guide de migration

Si vous utilisez actuellement @nestjs/swagger@3.*, notez les changements/API incompatibles suivants dans la version 4.0.

Changements importants

Les décorateurs suivants ont été modifiés / renommés :

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

Les changements importants de DocumentBuilder (signatures de méthode mises à jour) :

addTag
addBearerAuth
addOAuth2
setContactEmail est maintenant setContact
setHost a été supprimé
setSchemes a été supprimé (utilisez addServer à la place, par exemple, addServer('http://'))

Les méthodes suivantes ont été ajoutées :