org.springdoc.core.customizers

Class SpringDocCustomizers

java.lang.Object

org.springdoc.core.customizers.SpringDocCustomizers

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class SpringDocCustomizers
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

The type Spring doc customizers.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor and Description
SpringDocCustomizers(Optional<List<OpenApiCustomiser>> openApiCustomizers, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<RouterOperationCustomizer>> routerOperationCustomizers, Optional<List<DataRestRouterOperationCustomizer>> dataRestRouterOperationCustomizers, Optional<List<OpenApiMethodFilter>> methodFilters, Optional<List<GlobalOpenApiCustomizer>> globalOpenApiCustomizers, Optional<List<GlobalOperationCustomizer>> globalOperationCustomizers, Optional<List<GlobalOpenApiMethodFilter>> globalOpenApiMethodFilters) Instantiates a new Spring doc customizers.
SpringDocCustomizers(Optional<List<OpenApiCustomiser>> openApiCustomizers, Optional<List<OperationCustomizer>> operationCustomizers, Optional<List<RouterOperationCustomizer>> routerOperationCustomizers, Optional<List<OpenApiMethodFilter>> openApiMethodFilters) Instantiates a new Spring doc customizers.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
Optional<List<DataRestRouterOperationCustomizer>>	getDataRestRouterOperationCustomizers() Gets data rest router operation customizers.
Optional<List<GlobalOpenApiCustomizer>>	getGlobalOpenApiCustomizers() Gets global open api customizers.
Optional<List<GlobalOpenApiMethodFilter>>	getGlobalOpenApiMethodFilters() Gets global open api method filters.
Optional<List<GlobalOperationCustomizer>>	getGlobalOperationCustomizers() Gets global operation customizers.
Optional<List<OpenApiMethodFilter>>	getMethodFilters() Gets method filters.
Optional<List<OpenApiCustomiser>>	getOpenApiCustomizers() Gets open api customizers.
Optional<List<OperationCustomizer>>	getOperationCustomizers() Gets operation customizers.
Optional<List<RouterOperationCustomizer>>	getRouterOperationCustomizers() Gets router operation customizers.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringDocCustomizers

public SpringDocCustomizers(Optional<List<OpenApiCustomiser>> openApiCustomizers,
                            Optional<List<OperationCustomizer>> operationCustomizers,
                            Optional<List<RouterOperationCustomizer>> routerOperationCustomizers,
                            Optional<List<DataRestRouterOperationCustomizer>> dataRestRouterOperationCustomizers,
                            Optional<List<OpenApiMethodFilter>> methodFilters,
                            Optional<List<GlobalOpenApiCustomizer>> globalOpenApiCustomizers,
                            Optional<List<GlobalOperationCustomizer>> globalOperationCustomizers,
                            Optional<List<GlobalOpenApiMethodFilter>> globalOpenApiMethodFilters)

Instantiates a new Spring doc customizers.

Parameters:

openApiCustomizers - the open api customizers

operationCustomizers - the operation customizers

routerOperationCustomizers - the router operation customizers

dataRestRouterOperationCustomizers - the data rest router operation customizers

methodFilters - the method filters

globalOpenApiCustomizers - the global open api customizers

globalOperationCustomizers - the global operation customizers

globalOpenApiMethodFilters - the global open api method filters

SpringDocCustomizers

public SpringDocCustomizers(Optional<List<OpenApiCustomiser>> openApiCustomizers,
                            Optional<List<OperationCustomizer>> operationCustomizers,
                            Optional<List<RouterOperationCustomizer>> routerOperationCustomizers,
                            Optional<List<OpenApiMethodFilter>> openApiMethodFilters)

Instantiates a new Spring doc customizers.

Parameters:

openApiCustomizers - the open api customizers

operationCustomizers - the operation customizers

routerOperationCustomizers - the router operation customizers

openApiMethodFilters - the open api method filters

Method Detail

getOpenApiCustomizers

public Optional<List<OpenApiCustomiser>> getOpenApiCustomizers()

Gets open api customizers.

Returns:

the open api customizers

getOperationCustomizers

public Optional<List<OperationCustomizer>> getOperationCustomizers()

Gets operation customizers.

Returns:

the operation customizers

getRouterOperationCustomizers

public Optional<List<RouterOperationCustomizer>> getRouterOperationCustomizers()

Gets router operation customizers.

Returns:

the router operation customizers

getDataRestRouterOperationCustomizers

public Optional<List<DataRestRouterOperationCustomizer>> getDataRestRouterOperationCustomizers()

Gets data rest router operation customizers.

Returns:

the data rest router operation customizers

getMethodFilters

public Optional<List<OpenApiMethodFilter>> getMethodFilters()

Gets method filters.

Returns:

the method filters

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getGlobalOpenApiCustomizers

public Optional<List<GlobalOpenApiCustomizer>> getGlobalOpenApiCustomizers()

Gets global open api customizers.

Returns:

the global open api customizers

getGlobalOperationCustomizers

public Optional<List<GlobalOperationCustomizer>> getGlobalOperationCustomizers()

Gets global operation customizers.

Returns:

the global operation customizers

getGlobalOpenApiMethodFilters

public Optional<List<GlobalOpenApiMethodFilter>> getGlobalOpenApiMethodFilters()

Gets global open api method filters.

Returns:

the global open api method filters