在Swigger with spring中，是否可以将响应的示例值设置为与方法的返回类型不同？

8tntrjer 于 2021-09-13 发布在 Java

关注(0)|答案(0)|浏览(165)

@ApiResponses(value = { @ApiResponse(code = 200, message = "ok", response = AuthResponse.class),
            @ApiResponse(code = 403, message = "Forbidden", response = HttpClientErrorException.Forbidden.class),
            @ApiResponse(code = 500, message = "error", response = ServerError.class), })
    @ApiOperation(value = "auth", notes = "auth")
    @PostMapping("/user/refreshToken")
    public ResponseEntity<CommonResponse> someMethod(String someParam) {

        return ResponseEntity.ok().body(CommonResponse);
    }

它由定义中的公共内容组成 CommonResponse 对象，并在其中包含作为对象的特定响应。在swagger中，我使用了如上所述的注解，因为我想显示其中包含的对象，而不是 CommonResponse 对象但它并没有像我预期的那样工作，它只是显示了commonresponse，这是该方法的返回类型。此外，如下图所示， @ApiResponse 的message标记对于200代码以外的代码响应效果很好，但response标记似乎没有任何作用。如何自定义swagger中响应的exmaple值？