java - Swagger 在 204(无内容)上生成响应正文

Question

这是一个删除端点:

@ApiOperation(value = "delete subscription")
@ApiResponses(value = {
                @ApiResponse(code = 204, message = "Deleted", response = Void.class),
                @ApiResponse(code = 404, message = "Not Found")
})
@DeleteMapping("/{id}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public ListenableFuture<ResponseEntity<Void>> delete(@PathVariable long id)

Springfox 生成带有响应主体的 API 规范:

{
  "cancelled": true,
  "done": true
}

显然我希望 204 的响应正文规范为空。如何实现？

注意如果我将端点更改为同步:

public void delete(@PathVariable long id)

那么生成的 API 就可以了。

Answer 1

尝试添加

.genericModelSubstitutes(ListenableFuture.class)

到您的 Docket 配置以支持 ListenableFuture<T> .

文档:http://springfox.github.io/springfox/javadoc/2.7.0/springfox/documentation/spring/web/plugins/Docket.html#genericModelSubstitutes(java.lang.Class...)

Substitutes each generic class with it's direct parameterized type. genericModelSubstitutes(ResponseEntity.class) would substitute ResponseEntity<MyModel> with MyModel

例如:

return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build()
            .genericModelSubstitutes(ListenableFuture.class);