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
static GroupedOpenApi.Builder	builder() Builder builder.
String	getGroup() Gets group.
List<OpenApiCustomiser>	getOpenApiCustomisers() Gets open api customisers.
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.

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

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