NestJs Swagger 混合类型

Posted 2023-03-10

【中文标题】NestJs Swagger 混合类型

【英文标题】：NestJs Swagger mixed types

【发布时间】：2021-03-04 10:42:48

【问题描述】：

我有一个类，其中一个属性可以是字符串或字符串数​​组，不知道我应该如何在 swagger 中定义它

    @ApiProperty(
        description: `to email address`,
        type: ???, <- what should be here?
        required: true,
    )
    to: string | Array<string>;

更新

正如@Youba 建议的答案，我试过了

    @ApiProperty(
        description: `to email address(es)`,
        additionalProperties: 
            oneOf: [
                 type: 'string' ,
                 type: 'Array<string>' ,
            ],
        ,
        required: true,
    )

和

    @ApiProperty(
        description: `to email address(es)`,
        additionalProperties: 
            oneOf: [
                 type: 'string' ,
                 type: 'string[]' ,
            ],
        ,
        required: true,
    )

和

    @ApiProperty(
        description: `to email address(es)`,
        additionalProperties: 
            oneOf: [
                 type: 'string' ,
                 type: '[string]' ,
            ],
        ,
        required: true,
    )

但结果如下图，不正确

【参考方案1】：

请尝试

@ApiProperty(
   oneOf: [
       type: 'string' ,
       
         type: 'array',
         items: 
            type: 'string'
         
      
   ]
)

Array<TItem> 可以在 OpenAPI 中用type: 'array', items: type: TItem 表示