http response status annotation generation

[andruskutt]

Migrating from openapi generator.

I have usecase when single successful response of endpoint does not have http status code 200, but something else, typically 204

responses:
  "204":
   description: done

I did not found possibility to automatically generate @ResponseStatus(HttpStatus.NO_CONTENT) annotation for api interface
method?
Manually adding annotation to api implementation method seems errorprone if openapi definition file created and updated by somebody else?
Automatic generation should probably only work if result-style: success

[hauner]

Currently, there is no explicit support for this. You would use a ResponseEntity wrapper or ResponseStatus to set the response code.

I see that it is not perfect to keep that in sync with the OpenAPI manually.

What would be the rule to add it automatically? Something like:

Add ResponseStatus if the endpoint has a single success response code not 200.

If added automatically, I wonder if it is worth skipping it for 200. I think yes, less noise for most endpoint 😊

[andruskutt]

Maybe something like that - generate spring ResponseStatus annotation with http status code:

• if there is only single response code defined with value other than 200
• or there are multiple response codes defined and result-style == success for endpoint url/method and there is single success response (2XX) with code other than 200

AND there is no response wrapper generated for endpoint
Not required as spring seems to prioritize ResponseEntity over annotation The status code is applied to the HTTP response when the handler method is invoked, but does not override status information set by other means, such as ResponseEntity or "redirect:". ref and maybe we may want other types of wrappers too which don't have status override?

Less noise in generated code is one of reasons i'm trying to migrate away from openapi generator :)

[hauner]

created #339