Swagger @ApiOperation 可以允許在 Java 中指定一個列表嗎？

Question

我在 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 ，我可以在其中指定 response =MyCustomClass.class , responseContainer = "List" 但只有在 List of List 作為返回類型時才會出現問題，我在生成 swagger 文檔時沒有問題。

謝謝

拉維

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

還有另一個問題在這里討論了同樣的問題