SpringFox招摇过市-删除200个响应

Question

我正在使用Swagger注释和SpringFox为我的REST API（使用Sprint Boot构建）生成Swagger规范。我正在用将返回的@ApiContent代码注释每个方法。例如：

@DeleteMapping("/{pipelineName}")
@ApiOperation(value = "Delete a specific pipeline")
@ApiResponses({
    @ApiResponse(code = 204, message = "Pipeline has been deleted"),
    @ApiResponse(code = 404, message = "Pipeline does not exist")
})
public void deletePipeline(@PathVariable("pipelineName") @ApiParam(value = "Name of pipeline", required = true) String name){
    ...
}

然而，有些东西（我假设SpringFox）正在向每个API调用添加一个200响应代码，而不管它是否已定义。我知道我可以通过在每个方法中添加@ResponseStatus注释来删除此项，但a）这似乎是@ApiResponse定义的不必要重复，b）某些方法可能返回多个2xx代码中的一个。

有没有办法或者去掉默认添加的200代码？

Answer 1

目前无法删除标准的200代码。我在github上发现了同样的问题，开发人员说这是springfox的错误：

你可以在这个链接中阅读

我试图删除2.9.2版本的SpringFox中的200代码，这个错误仍然存在

Answer 2

我要做的是：

    @DeleteMapping("/{pipelineName}")
    @ApiOperation(value = "Delete a specific pipeline")
    @ApiResponses({
        @ApiResponse(code = 204, message = "Pipeline has been deleted"),
        @ApiResponse(code = 404, message = "Pipeline does not exist")
    })
    public @ResponseBody ResponseEntity<Object> deletePipeline(@PathVariable("pipelineName") @ApiParam(value = "Name of pipeline", required = true) String name){
        if (deleted) {
       return new ResponseEntity<>("Pipeline has been deleted", HttpStatus.CREATED); //code 204
} else {
return new ResponseEntity<>("Pipeline does not exist", HttpStatus.NOT_FOUND); //code 404
}
    }

现在，我不会使用204作为代码来表示删除了某些内容，我会将其保持在200，但这取决于您。

希望这有帮助！

Answer 3

我相信您需要定义您的方法的默认响应状态，正如您在问题中提到的。这并不完全是重复。HTTP 200响应是默认行为，Springfox不会做任何事情来改变这一点，所以它只是在自动检测到的代码之上添加额外的代码。

HTTP 204的示例：

@ResponseStatus(value = HttpStatus.NO_CONTENT)

在代码中：

DeleteMapping("/{pipelineName}")
@ApiOperation(value = "Delete a specific pipeline")
@ApiResponses({
    @ApiResponse(code = 204, message = "Pipeline has been deleted"),
    @ApiResponse(code = 404, message = "Pipeline does not exist")
})
@ResponseStatus(value = HttpStatus.NO_CONTENT)
public void deletePipeline(@PathVariable("pipelineName") @ApiParam(value = "Name of pipeline", required = true) String name){
    ...
}

对于可能正在检查此主题的其他人：如果Springfox正在生成其他HTTP代码，您可能也需要此代码。