Java: Is it possible to use swagger-core annotations w/o any adapters?

Asked Feb 23 '18 at 12:32

Active Feb 23 '18 at 12:46

Viewed 91 times

I'm wondering is it possible to build Swagger documentation based only on swagger-core annotations w/o help of any adapters like jax-rs or springfox?

Why asking the question: e.g. when using springfox it relies on Spring annotations like @RequestMapping, @ResponseStatus etc. Imagine I want to specify a POST method which returns 201 by default:

@ApiOperation(value = "some api")
@ApiResponses(value = {
                @ApiResponse(code = 201, message = "Created")
})
@RequestMapping(method = RequestMethod.POST)
@ResponseStatus(HttpStatus.CREATED)

Without the last line springfox will generate the 200 status by default which I don't want to be a part of the spec. And ofc I don't want to add an imperative @ResponseStatus annotation to the controller.

I.e. I want to be in full control of the generated API spec which should rely on swagger core annotations only.

edited Feb 23 '18 at 12:46

asked Feb 23 '18 at 12:32

S. Pauk

5,208
4
31
41

You can set the `useDefaultRssponseMessages(false)` and the annotations will work without having to specific `ResponseStatus` – Dilip Krishnan Feb 24 '18 at 13:19
@DilipKrishnan the springfox author by himself says ResponseStatus is needed, check https://github.com/springfox/springfox/issues/632#issuecomment-99104202 – S. Pauk Feb 26 '18 at 07:44
ouch, that is you :) So has it been fixed in recent versions? – S. Pauk Feb 26 '18 at 07:45
tried with 2.8.0 - `ResponseStatus` is still needed to eliminate `200` default response. – S. Pauk Feb 26 '18 at 07:57
Yeah that’s me . Might want to raise a bug for that, I assumed it was fixed, sorry. – Dilip Krishnan Feb 26 '18 at 13:01

Java: Is it possible to use swagger-core annotations w/o any adapters?

0 Answers0