如何删除Springfox Swagger中操作的响应体？

Question

我在一个REST服务中工作，该服务是由Spring Boot的，到目前为止，它是使用springfox-swagger2:2.7.0（首先实现）记录的。我添加的最后一个操作如下：

@ApiOperation(value = "whatever")
  @ApiResponses({
    @ApiResponse(code = HttpURLConnection.HTTP_NO_CONTENT, message = "Returns empty content when succeeds"),
    @ApiResponse(code = HttpURLConnection.HTTP_FORBIDDEN, message = "You can't do that.")
  })
@CrossOrigin
@PreAuthorize("hasAuthority('USER_ACCESS')")
@RequestMapping(value = "/foo", method = POST, consumes = APPLICATION_JSON_VALUE)
@ResponseStatus(HttpStatus.NO_CONTENT)
public ResponseEntity postFoo(
  @RequestBody
  FooRequestBody requestBody) {

  if (someMethodReturnsTrue()) {
    return ResponseEntity.status(HttpStatus.NO_CONTENT).build();
  } else {
    return ResponseEntity.status(HttpStatus.UNAUTHORIZED).build();
  }
}

现在，问题是无论如何，生成的斯瓦格定义最终看起来像这样：

"responses": {
  "204": {
    "description": "Returns empty content when succeeds",
    "schema": {
      "$ref": "#/definitions/ResponseEntity"
    }
  },
  "403": {
    "description": "You can't do that."
  }
}

如果这个操作不返回任何内容，我理解204响应应该没有模式字段（像另一个字段一样）。

我尝试在@ApiParam注释中指定响应=Void.class（如其他线程中建议的），但没有任何乐趣（因为它是默认值，所以无法与不指定它区分开来）。

我还尝试了在我的Docket bean中设置GenericModelSubures（响应ntity.class），但没有任何效果。

我知道，如果someMethodReturnsTrue（）确实返回false，我可以返回void并抛出异常，而不是返回ResponseEntity。然后，@ExceptionHandler方法可以将该异常转换为403状态代码。

我认为这是大材小用，我认为我不应该改变我的实现来修复我的留档。这就是为什么我问，有没有办法告诉Springfox忽略那个特定方法的返回值，并将其视为返回了val？

谢谢。

Answer 1

加：

@ApiResponse(code = 204, response = void.class, message = "No Content")

到您的@Api响应（{...}）注释。重要的是使用void.class代替Void.class。所以它与默认值不同，您仍然可以使用响应实体作为返回类型。

Answer 2

找到了解决方法，因为@Apiop的默认行为是返回方法的返回类型，所以对于每个状态，都会返回方法的返回类型。如果要发送空响应，请写

@ApiResponse(code = 204, message = "No User found for that Id",response = Object.class)

在SwaggerConfig中写道

 @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .directModelSubstitute(Object.class, java.lang.Void.class);          
    }

所以每当一个物体。类返回时，swagger将自动将其转换为Void。班