swagger 2.0如何处理参数或返回类型中的泛型?

时间:2015-06-04 06:22:16

标签: swagger api-doc swagger-2.0

我正在使用Swagger 2.0生成文档。在我的控制器类中,我有一些操作,如

public Page<Employee> getEmployees(Pageable pageable) {....}

为上述操作的响应而生成的swagger文件

"responses" : {
          "200" : {
            "schema" : {
              "$ref" : "#/definitions/Page"
              } 
            }
          }

在这里,Swagger文档未能说明响应是Page<Employee>。如何以傲慢的方式获取通用数据文档?

如果我的返回类型为

,该怎么办?
Page<String,Employee>
Page<Employee,List<Department>>
Page<Employee,Tuple.Two<String,User>>

Swagger Operation参数和Model属性也是如此。

1 个答案:

答案 0 :(得分:0)

这是Swagger的已知问题,请检查以下问题:https://github.com/OAI/OpenAPI-Specification/issues/957。要点是,您需要创建自己的扩展来描述泛型。