Response code in Response Entity ignored

[jfearon]

I've setup a endpoint that takes a POST, and returns a 201. If you set this up as:

@ApiOperation(value = "Create a new thing",
        notes = "Insert a new thing into the system"
)
@ApiResponses(value = {
        @ApiResponse(code = 400, message = "Thing failed validation", response = ValidationException.class)})
@RequestMapping(method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<Thing> newThing(@RequestBody Thing thing) {

    Thing insertedThing = thingService.insertThing(thing);
    return new ResponseEntity<Thing>(thing, HttpStatus.CREATED);

}

Then this generates as returning a 200 status code:

"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Thing"}}

By contrast this:

@ApiOperation(value = "Create a new thing",
        notes = "Insert a new thing into the system"
)
@ApiResponses(value = {
        @ApiResponse(code = 400, message = "Thing failed validation", response = ValidationException.class)})
@RequestMapping(method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
@ResponseStatus(value= HttpStatus.CREATED)
public Thing newThing(@RequestBody Thing thing) {

    Thing insertedThing = thingService.insertThing(thing);
    return insertedThing;

}

Seems to work fine. Should the ResponseEntity parameter be picked up?

[dilipkrish]

A hybrid of what you have should work

@ApiOperation(value = "Create a new thing",
        notes = "Insert a new thing into the system"
)
@ApiResponses(value = {
         @ApiResponse(code = 201, message = "Thing was created "), //<----this and/or
        @ApiResponse(code = 400, message = "Thing failed validation", response = ValidationException.class)})
@RequestMapping(method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
@ResponseStatus(value= HttpStatus.CREATED) // <---- and/or this
public ResponseEntity<Thing> newThing(@RequestBody Thing thing) {

    Thing insertedThing = thingService.insertThing(thing);
    return new ResponseEntity<Thing>(thing, HttpStatus.CREATED);

}

[jfearon]

Ah, both of those do work, though it seems a shame to have to put the status in twice. I experimented with the code parameter on ApiOperation too, but that also seems to be ignored.

Anyway thanks for the quick response - feel free to close, sorry for not realising I could have the annotation and the ResponseEntity....

[dilipkrish]

put the status in twice

where? It's either in the ResponseStatus or in the ApiResponse. If you're talking about the one in your method body, well that's implementation details not visible to the library.

[davidnewcomb]

This report is pointed to from "Answers to common questions and problems -> Why does springfox ignore the http status code in the return value of a controller method?" but it doesn't answer the question it only confirms that the code is ignored.
I don't understand why this isn't a bug. The user is programmatically setting the response code and the annotation (or lack of annotation) is modifying it.

[dilipkrish]

@davidnewcomb Iike I mentioned, this library works by using annotations and reflection. Its not able to introspect method bodies and examine implementation details.

[stefan-huettemann]

I am running on spring-boot 1.5.1 and springfox-swagger2:2.6.1.

I would like to pick up the question from @davidnewcomb.

I too see that there is a problem with the attribute code in the annotation @ApiOperation.

According to the JavaDoc the attribute code should reflect the HTTP return code of the operation annotated by @ApiOperation. The default is said to be 200.

Therefore annotating a (RestController) method with @ApiOperation(code = 201)
should change the swagger-ui line "Response Class (Status 200)" to something like "Response Class (Status 201)".

But it does not. I would call this a bug :)

Note: yes you can additionally add the 201 response code with @ApiResponse but that is not the same as changing the default code on @ApiOperation.