java - Swagger @ApiOperation 可以允许在 Java 中指定列表列表吗？

Question

我在 Java 类中有一个方法，其签名如下所示，我想为其添加 Swagger Rest 文档。

public List<List<MyCustomClass>> getMyCustomClasses(String id){
//
}

我想知道是否有办法让 response 或 responseContainer 返回 List 对象的 List？像下面这样的东西？

@ApiOperation(value = "find MyCustomClass objects by id", response =MyCustomClass.class , responseContainer =   "List<List>")

如果方法的响应只是列表，我在生成 swagger 文档时没有问题我可以在其中指定 response =MyCustomClass.class , responseContainer = "List"但只有当它是 List of List 作为返回类型时才会出现问题。

谢谢

拉维

Answer 1

为此，您可以简单地创建一个模板类，如下所示:

public class TempClass {
   private List<someClass> listOfClass;
   public List<someClass> getListOfClass() {
      return listOfClass;
   }
   public void setListOfClass(List<someClass> listOfClass) {
      this.listOfClass = listOfClass;
   }
}

或者像这样更复杂:

public class TempClass {
   private List<List<List<someClass>>> listOfList;
   public List<List<List<someClass>>> getListOfList(){ 
      return listOfList;
   }
   public void setListOfList(List<List<List<someClass>>> listOfList) {
      this.listOfList = listOfList;
   }
}

最后获取此类作为对方法上方注释的响应，如下所示:

@ApiOperation(response = TempClass.class)

您还应该将方法的返回类型指定为 TempClass

还有一个issue讨论了同样的问题here