CODEWITHSUNDEEP
springdocspringdoc-openapi-uiswagger-3.0
VianneN
VianneN

Reputation: 143

What is the Springdoc equivalent of the Swagger 2 Springfox useDefaultResponseMessages() method?

We are moving away from Springfox to Springdoc and would like to know if Springdoc has a useDefaultResponseMessages() equivalent?

Have seen some solutions that require some coding but what I would like to know if there is something that can be implemented as simply as the useDefaultResponseMessages()

When creating a default docket in springfox it is very simply added like so.

defaultDocket
            .useDefaultResponseMessages(true)
            .select()

Upvotes: 1

Views: 1242

Answers (1)

brianbro
brianbro

Reputation: 4809

Yes, you can use OpenApiCustomiser, to add global responses for your APIs.

@Bean
public OpenApiCustomiser customerGlobalHeaderOpenApiCustomiser() {
    return openApi -> {
        openApi.getPaths().values().forEach(pathItem -> pathItem.readOperations().forEach(operation -> {
            ApiResponses apiResponses = operation.getResponses();
            ApiResponse apiResponse = new ApiResponse().description("Custom Error")
                    .content(new Content()
                                .addMediaType(org.springframework.http.MediaType.APPLICATION_JSON_VALUE, new MediaType()));
            apiResponses.addApiResponse("400", apiResponse);
        }));
    };
}

Upvotes: 1

Related Questions