Nestjs / swagger:复杂对象

时间:2018-06-18 16:20:37

标签: swagger nestjs

我想知道是否有办法支持Nestjs / swagger的复杂对象。我刚刚完成了迁移,现在正在研究swagger文档。我的很多请求都返回了复杂的对象,所以我想知道是否有更简单的方法。 例如:

class Foobar{
  prop1: {
    subprop1: {
      subsub1: string;
    };
  };
}

成为:

class SubSub{
  @ApiModelProperty()
  subsub1: string;
}
class SubProp{
  @ApiModelProperty()
  subporp1: SubSub;
}
class Foobar {
  @ApiModelProperty()
  prop1: SubProp;
}

如果我这样做:

class Foobar{
  @ApiModelProperty()
  prop1: {
    subprop1: {
      subsub1: string;
    };
  };
}

我大摇大摆地说:

{
  "prop1": {}
}

1 个答案:

答案 0 :(得分:1)

class SubSub{
 @ApiModelProperty()
  subsub1: string;
}
class SubProp{
 @ApiModelProperty({type: SubSub)
  subporp1: SubSub;
}
class Foobar {
 @ApiModelProperty({type: SubProp)
 prop1: SubProp;
}

@ApiModelProperty带有一个选项对象,如果它是一个复杂的对象,则可以在其中指定type