Nestjs + Swagger：如何向@ApiProperty 添加自定义选项

Question

是否可以向 @ApiProperty 装饰器添加自定义选项？

import { ApiProperty } from '@nestjs/swagger';

class Animal {

  @ApiProperty({
    type: String,
    description: 'animal name',
    'x-description': 'some information' // how to add a cutom option 'x-description' ?
  })
  name: string;
}

Answer 1

我不确定我是否完全理解，但如果你在谈论openapi 的扩展。 看看这个： https ://github.com/nestjs/swagger/issues/195

Answer 2

来自https://github.com/nestjs/swagger/issues/195#issuecomment-526215840的解决方案

import { ApiProperty } from '@nestjs/swagger';

type SwaggerDecoratorParams = Parameters<typeof ApiProperty>;
type SwaggerDecoratorMetadata = SwaggerDecoratorParams[0];
type Options = SwaggerDecoratorMetadata & DictionarySwaggerParameters;
type DictionarySwaggerParameters = { 'x-property'?: string };

export const ApiPropertyX = (params: Options) => {
  return ApiProperty(params);
};