New Feature: OpenAPICustomiser

[davidmelia]

Hi,

I have a requirement to add a common header to every API call so I've come up with the following:

1. Turn off the default springdoc OpenApiResource:
   springdoc.api-docs.enabled=false
2. Create a customisable interface

public interface OpenAPICustomiser {
  public void customise(OpenAPI openApi);
}

3. Extend OpenApiResource and add the optional customiser check.

@RestController
public class CustomisableOpenApiResource extends org.springdoc.api.OpenApiResource {

private final Optional<List<OpenAPICustomiser>> openApiCustomisers;
. . .
  @Override
  protected OpenAPI getOpenApi() {
    final OpenAPI openApi = super.getOpenApi();
    if (openApiCustomisers.isPresent()) {
      openApiCustomisers.get().stream().forEach(openApiCustomiser -> openApiCustomiser.customise(openApi));
    }
    return openApi;
  }

4. Add one to many customisations - following shows adding a common header to every operation:

  @Bean
  public OpenAPICustomiser consumerTypeHeaderOpenAPICustomiser() {
    return openApi -> openApi.getPaths().values().stream().flatMap(pathItem -> pathItem.readOperations().stream())
        .forEach(operation -> operation.addParametersItem(new HeaderParameter().$ref("#/components/parameters/myConsumerTypeHeader")));
  }

Would it be possible to provide this ability in the default org.springdoc.api.OpenApiResource?

Thanks

[springdoc]

Hi,

Can you propose a pull request, with this feature ?

[davidmelia]

sure will have a go this week. Thanks

[davidmelia]

@springdoc have a look at

#93

Thanks

[springdoc]

Hi,

Thank you for your contribution.
This feature, will be available on v1.1.43 of springdoc-openapi.