在 swagger 注释中参数化 class

Question

从我的 spring 休息服务，我返回响应为 -

return new ResponseEntity<ExampleOutputData>(exampleService.exampleServiceCall(inputData), responseHeaders, HttpStatus.ACCEPTED);

我在注释中提到的响应是 -

 @ApiResponses(value = { 
            @ApiResponse(code = 202, message = "Success", response = ResponseEntity.class)})

我收到的 yaml 文档响应为 -

  responses:
    202:
      description: "Success"
      schema:
        $ref: "#/definitions/ResponseEntity"

我的问题是如何在响应中提及 ExampleOutputData，因为实际上我的响应是 ResponseEntity<ExampleOutputData>

或者不需要并且当前的实现和 swagger 定义是完美的？

Answer 1

为了在响应中包含 ExampleOutputData，您只需将 ResponseEntity.class 更改为 ExampleOutputData.class:

@ApiResponses(value = {@ApiResponse(code = 202, message = "Success", response = ExampleOutputData.class)})

参见文档 here。

Having parametrized class in swagger annotations