文章/答案/技术大牛

发布

社区首页 >问答首页 >如何让`[key: string]：string`出现在NestJS Swagger生成中

问如何让`[key: string]：string`出现在NestJS Swagger生成中
EN

Stack Overflow用户

提问于 2021-07-16 19:47:28

回答 1查看 130关注 0票数 2

我有以下类来表示一个响应：

class SomeResponse {
  property1?: string;
  [key: string]: string
}

我想使用nest-cli为这个响应生成正确的swagger文档。它适用于我的所有其他simpler属性，即property1在swagger中正确显示。我还尝试使用以下命令直接进行注释：

class SomeResponse {
  property1?: string;
  @ApiProperty()
  [key: string]: string
}

但这是不允许的，因为这给出了：error TS1206: Decorators are not valid here.

有没有一种方法可以手动注释或使用诸如[key: string]: string之类的nest-cli结构进行注释

发布于 2021-07-17 02:06:41

不幸的是，它似乎不能将装饰符附加到索引签名。您也可以使用additionalProperties (请参阅here)，但它将生成嵌套对象。

class SomeResponse {
  @ApiProperty({ type: 'object', additionalProperties: { type: 'string' } })
  data: Record<string, string>;
}

这将被提取如下所示。

{
  "data": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

票数 0

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/68408494

复制

相似问题

问如何让`[key: string]：string`出现在NestJS Swagger生成中EN