org.springdoc.core

Class GroupedOpenApi.Builder

java.lang.Object

org.springdoc.core.GroupedOpenApi.Builder

Enclosing class:

GroupedOpenApi

public static class GroupedOpenApi.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
GroupedOpenApi.Builder	addOpenApiCustomiser(OpenApiCustomiser openApiCustomiser)
GroupedOpenApi.Builder	addOperationCustomizer(OperationCustomizer operationCustomizer)
GroupedOpenApi	build()
GroupedOpenApi.Builder	group(String group)
GroupedOpenApi.Builder	packagesToExclude(String... packagesToExclude)
GroupedOpenApi.Builder	packagesToScan(String... packagesToScan)
GroupedOpenApi.Builder	pathsToExclude(String... pathsToExclude)
GroupedOpenApi.Builder	pathsToMatch(String... pathsToMatch)
GroupedOpenApi.Builder	setGroup(String group) Deprecated. Since v1.4.0, GroupedOpenApi.setGroup is marked as deprecated. Use group(String) instead.

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.

group

public GroupedOpenApi.Builder group(String group)

pathsToMatch

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

packagesToScan

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

pathsToExclude

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

packagesToExclude

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

addOpenApiCustomiser

public GroupedOpenApi.Builder addOpenApiCustomiser(OpenApiCustomiser openApiCustomiser)

addOperationCustomizer

public GroupedOpenApi.Builder addOperationCustomizer(OperationCustomizer operationCustomizer)

build

public GroupedOpenApi build()