org.springdoc.core

Class GroupedOpenApi.Builder

java.lang.Object

org.springdoc.core.GroupedOpenApi.Builder

Enclosing class:

GroupedOpenApi

public static class GroupedOpenApi.Builder
extends Object

The type Builder.

Author:

bnasslahsen

Method Summary

Modifier and Type	Method and Description
GroupedOpenApi.Builder	addOpenApiCustomiser(OpenApiCustomiser openApiCustomiser) Add open api customiser builder.
GroupedOpenApi.Builder	addOperationCustomizer(OperationCustomizer operationCustomizer) Add operation customizer builder.
GroupedOpenApi	build() Build grouped open api.
GroupedOpenApi.Builder	consumesToMatch(String... consumesToMatch)
GroupedOpenApi.Builder	group(String group) Group builder.
GroupedOpenApi.Builder	headersToMatch(String... headersToMatch)
GroupedOpenApi.Builder	packagesToExclude(String... packagesToExclude) Packages to exclude builder.
GroupedOpenApi.Builder	packagesToScan(String... packagesToScan) Packages to scan builder.
GroupedOpenApi.Builder	pathsToExclude(String... pathsToExclude) Paths to exclude builder.
GroupedOpenApi.Builder	pathsToMatch(String... pathsToMatch) Paths to match builder.
GroupedOpenApi.Builder	producesToMatch(String... producesToMatch)
GroupedOpenApi.Builder	setGroup(String group) Deprecated. Since v1.4.0, GroupedOpenApi.setGroup is marked as deprecated. Use group(String) instead. will be removed with v1.5.0

Methods inherited from class java.lang.Object

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

Method Detail

setGroup

@Deprecated
public GroupedOpenApi.Builder setGroup(String group)

Deprecated. Since v1.4.0, GroupedOpenApi.setGroup is marked as deprecated. Use group(String) instead. will be removed with v1.5.0

Sets group.

Parameters:

group - the group

Returns:

the group

group

public GroupedOpenApi.Builder group(String group)

Group builder.

Parameters:

group - the group

Returns:

the builder

pathsToMatch

public GroupedOpenApi.Builder pathsToMatch(String... pathsToMatch)

Paths to match builder.

Parameters:

pathsToMatch - the paths to match

Returns:

the builder

packagesToScan

public GroupedOpenApi.Builder packagesToScan(String... packagesToScan)

Packages to scan builder.

Parameters:

packagesToScan - the packages to scan

Returns:

the builder

producesToMatch

public GroupedOpenApi.Builder producesToMatch(String... producesToMatch)

consumesToMatch

public GroupedOpenApi.Builder consumesToMatch(String... consumesToMatch)

headersToMatch

public GroupedOpenApi.Builder headersToMatch(String... headersToMatch)

pathsToExclude

public GroupedOpenApi.Builder pathsToExclude(String... pathsToExclude)

Paths to exclude builder.

Parameters:

pathsToExclude - the paths to exclude

Returns:

the builder

packagesToExclude

public GroupedOpenApi.Builder packagesToExclude(String... packagesToExclude)

Packages to exclude builder.

Parameters:

packagesToExclude - the packages to exclude

Returns:

the builder

addOpenApiCustomiser

public GroupedOpenApi.Builder addOpenApiCustomiser(OpenApiCustomiser openApiCustomiser)

Add open api customiser builder.

Parameters:

openApiCustomiser - the open api customiser

Returns:

the builder

addOperationCustomizer

public GroupedOpenApi.Builder addOperationCustomizer(OperationCustomizer operationCustomizer)

Add operation customizer builder.

Parameters:

operationCustomizer - the operation customizer

Returns:

the builder

build

public GroupedOpenApi build()

Build grouped open api.

Returns:

the grouped open api