org.springdoc.core

Class GroupedOpenApi

java.lang.Object

org.springdoc.core.GroupedOpenApi

public class GroupedOpenApi
extends Object

The type Grouped open api.

Author:

bnasslahsen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupedOpenApi.Builder The type Builder.

Method Summary

Modifier and Type	Method and Description
GroupedOpenApi	addAllOpenApiCustomizer(Collection<? extends OpenApiCustomiser> openApiCustomizerCollection) Add all open api customizer grouped open api.
GroupedOpenApi	addAllOpenApiMethodFilter(Collection<? extends OpenApiMethodFilter> openApiMethodFilterCollection) Add all open api method filter grouped open api.
GroupedOpenApi	addAllOperationCustomizer(Collection<? extends OperationCustomizer> operationCustomizerCollection) Add all operation customizer grouped open api.
static GroupedOpenApi.Builder	builder() Builder builder.
List<String>	getConsumesToMatch() Gets consumes to match.
String	getDisplayName() Gets display name.
String	getGroup() Gets group.
List<String>	getHeadersToMatch() Gets headers to match.
List<OpenApiCustomiser>	getOpenApiCustomisers() Gets open api customisers.
List<OpenApiMethodFilter>	getOpenApiMethodFilters() Gets open api method filters.
List<OperationCustomizer>	getOperationCustomizers() Gets operation customizers.
List<String>	getPackagesToExclude() Gets packages to exclude.
List<String>	getPackagesToScan() Gets packages to scan.
List<String>	getPathsToExclude() Gets paths to exclude.
List<String>	getPathsToMatch() Gets paths to match.
List<String>	getProducesToMatch() Gets produces to match.
List<RouterOperationCustomizer>	getRouterOperationCustomizers() Gets router operation customizers.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static GroupedOpenApi.Builder builder()

Builder builder.

Returns:

the builder

getProducesToMatch

public List<String> getProducesToMatch()

Gets produces to match.

Returns:

the produces to match

getHeadersToMatch

public List<String> getHeadersToMatch()

Gets headers to match.

Returns:

the headers to match

getConsumesToMatch

public List<String> getConsumesToMatch()

Gets consumes to match.

Returns:

the consumes to match

getGroup

public String getGroup()

Gets group.

Returns:

the group

getPathsToMatch

public List<String> getPathsToMatch()

Gets paths to match.

Returns:

the paths to match

getPackagesToScan

public List<String> getPackagesToScan()

Gets packages to scan.

Returns:

the packages to scan

getPackagesToExclude

public List<String> getPackagesToExclude()

Gets packages to exclude.

Returns:

the packages to exclude

getPathsToExclude

public List<String> getPathsToExclude()

Gets paths to exclude.

Returns:

the paths to exclude

getOpenApiCustomisers

public List<OpenApiCustomiser> getOpenApiCustomisers()

Gets open api customisers.

Returns:

the open api customisers

getOperationCustomizers

public List<OperationCustomizer> getOperationCustomizers()

Gets operation customizers.

Returns:

the operation customizers

getOpenApiMethodFilters

public List<OpenApiMethodFilter> getOpenApiMethodFilters()

Gets open api method filters.

Returns:

the open api method filters

getRouterOperationCustomizers

public List<RouterOperationCustomizer> getRouterOperationCustomizers()

Gets router operation customizers.

Returns:

the router operation customizers

getDisplayName

public String getDisplayName()

Gets display name.

Returns:

the display name

addAllOpenApiCustomizer

public GroupedOpenApi addAllOpenApiCustomizer(Collection<? extends OpenApiCustomiser> openApiCustomizerCollection)

Add all open api customizer grouped open api.

Parameters:

openApiCustomizerCollection - the open api customizer collection

Returns:

the grouped open api

addAllOperationCustomizer

public GroupedOpenApi addAllOperationCustomizer(Collection<? extends OperationCustomizer> operationCustomizerCollection)

Add all operation customizer grouped open api.

Parameters:

operationCustomizerCollection - the operation customizer collection

Returns:

the grouped open api

addAllOpenApiMethodFilter

public GroupedOpenApi addAllOpenApiMethodFilter(Collection<? extends OpenApiMethodFilter> openApiMethodFilterCollection)

Add all open api method filter grouped open api.

Parameters:

openApiMethodFilterCollection - the open api method filter collection

Returns:

the grouped open api