可以Swagger @APIOperation允许在Java中指定列表吗?

时间:2014-07-03 15:21:45

标签: java swagger swagger-ui

我在Java类中有一个带有下面签名的方法,我想为它添加Swagger Rest文档。

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

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

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

如果方法的响应只是List,那么生成swagger文档没有问题 我可以在哪里指定response = MyCustomClass.class,responseContainer =&#34; List&#34;但只有在列表列表作为返回类型时才有问题。

由于

拉​​维

1 个答案:

答案 0 :(得分:-1)

为了做到这一点,你可以简单地创建一个这样的模板类:

postSubmit: function (request, response) {
  var self = this;

  var event = request.body.event;    

  event.start = (event.start) ? moment(event.start, 'DD/MM/YYYY').format("YYYY-MM-DD 00:00:00") : null;
  event.end = (event.end) ? moment(event.end, 'DD/MM/YYYY').format("YYYY-MM-DD 00:00:00") : null;

  self.eventDao.save(event, function(modelError, event){
    if(modelError){
      response.redirect('/event/submit');
    }else{
      response.redirect('/');
    }
  });
},

甚至更复杂,如:

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;
   }
}

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

另一个问题是讨论同一问题here