如何为Swagger API响应指定泛型类型类

Question

我有大约40个API，它们具有类似的基本响应结构，如下所示：

{
    "lastAccessed": "2015-30-08:14:21:45T",
    "createdOn": "2015-30-07:09:04:10T",
    "lastModified": "2015-30-08:14:21:45T",
    "isReadOnly": "false",
    "usersAllowed" : ["Tim", "Matt", "Christine"];
    "noOfEntries": 1,
    "object": [
        "ObjectA": {
             //here object A has its own model
         }
    ]
}

因此，我有一个基本响应类，采用T类型的泛型，如下所示：

public class Response<T> {
    @ApiModelProperty(value="Last time accessed")
    private String lastAccessed;
    @ApiModelProperty(value="Time when Created ")
    private String createdOn;
    private String lastModified;
    @ApiModelProperty(value="Created on")
    private boolean isReadOnly;
    @ApiModelProperty(value="Users that has access to the object.")
    private List<String> usersAllowed;
    private int noOfEntries;
    private T object;

    //getters and setters
}

因此，对于API A，它返回类型为的对象及其自己的字段，我将返回响应作为控制器中的API响应：

  public class A {
    @ApiModelProperty(value="Name")
    private String name;
    @ApiModelProperty(value="OID")
    private String id;    
    //getters and setters
}    

在控制器中：响应数据=新响应（）；ResponseEntity response=新的ResponseEntity

在swagger中有没有一种方法可以递归地指定响应对象的模型？例如，我可以使用注释@ApiOperation（response=response.class），但它不会使用A的模型。

Answer 1

这个问题是在2015年提出的，但我在2020年也在寻找同样的问题。：）所以，我觉得有必要补充一下我在这里发现的东西。

我正在使用springdoc-openapi-用户界面（1.5.0），这取决于Swagger JAR，我明白。由于公共响应类采用通用的T，因此实际的API方法必须定义预期的类型。例如，响应

如果这也是您的场景，那么不定义@ApiResponse的schema属性-

Answer 2

我知道这是一篇旧文章，但对于任何寻找答案的人来说：

这可以用于列表、集合、和映射响应对象，但任何其他具有泛型类型的类都将被忽略。如果您正在使用这三个选项中的任何一个，那么可以在responseContainer字段中指定它们，并在response字段中指定推断的类型。

@ApiResponse(code = 200, responseContainer="List", respone=java.lang.String.class)

Answer 3

我正在使用swagger 2和Follow解决了这个问题。

从@ApiResponse和@ApiOperation中删除“response”属性。然后，swagger将根据方法存根为您自动生成200 OK的响应类（无论响应类中是否包含泛型）。

@ApiOperation(value = "what your operation does")

@ApiResponses(value = { @ApiResponse(code = 200, message = "Success message") })

更新：你可以做这个简单的工作。只需说你想输出响应

>

在控制器类中，指定一个空的私有类，如下所示

private MyResponseClass扩展了响应

对于招摇过市的规格，指定如下：，

@ApiResponse（code=200，respone=MyResponseClass.class）

请记住，目前，swagger不支持泛型。以上两个只是变通方法。