Add ability to disable default responses

[pohorilyi]

I want to migrate from SpringFox library to SpringDoc. In my SpringFox configuration, I have disabled default response messages:

@Bean
public Docket publicApi(ServletContext servletContext) {
    Docket docket = new Docket(DocumentationType.SWAGGER_2)
        ...
        .useDefaultResponseMessages(false);

But I can't find a way to do it in SpringDoc. Migration guide says "remove Docket and use application.properties instead". But there is no such property.

Solution I'd like

• Posibility to disable default responses as a property in application.properties
• Expected result using OpenAPI Description - json

[bnasslahsen]

@pohorilyi,

If you define a response description, it will used instead.
Each response status requires a description. So if it's empty, springdoc-openapi produces a default response. Otherwise you get incorrect OpenAPI document.

[pohorilyi]

@bnasslahsen,

thanks for answering my question. But according to springdoc demo it is possible to have only a few response codes included in the document. e.g. here is only 200 and 400.
http://158.101.164.60:8081/v3/api-docs/users

For a similar get endpoint springdoc adds a lot of other responses by default.

Do I understand correctly, document in demo is incorrect? And it is not possible to generate document only with some specified responses?

[bnasslahsen]

@pohorilyi,

According to the demo, springdoc reflects the http responses that are available on the code:

• If you have seen the demo in details: HTTP 200 comes from the controller
• HTTP 400 code comes from a global exception handler.

By default: springdoc automatically adds @ControllerAdvice responses to all the generated responses.
If you want disable this, you have:

springdoc.override-with-generic-response= false

Note that mainly: springdoc-openapi reflects the http codes that are available on your code.
And this can be customized, if you use @ApiResponse annotations.

[pohorilyi]

@bnasslahsen,

thanks a lot for the explanation 🙏 Now it's much more clear.
springdoc.override-with-generic-response= false is what I was looking for. I should have dived deeper into the docs.

[istibekesi]

@bnasslahsen Is it possible to keep default response configuration true and hide some of them on specific endpoints with @ApiResponse?