Package org.springdoc.core.models
Class GroupedOpenApi.Builder
java.lang.Object
org.springdoc.core.models.GroupedOpenApi.Builder
- Enclosing class:
- GroupedOpenApi
The type Builder.
- Author:
- bnasslahsen
-
Method Summary
Modifier and TypeMethodDescriptionaddOpenApiCustomizer
(OpenApiCustomizer openApiCustomizer) Add open api customiser builder.addOpenApiMethodFilter
(OpenApiMethodFilter methodFilter) Add method filter.addOperationCustomizer
(OperationCustomizer operationCustomizer) Add operation customizer builder.addRouterOperationCustomizer
(RouterOperationCustomizer routerOperationCustomizer) Add router operation customizer builderbuild()
Build grouped open api.consumesToMatch
(String... consumesToMatch) Consumes to match builder.displayName
(String displayName) Display name builder.Group builder.headersToMatch
(String... headersToMatch) Headers to match builder.packagesToExclude
(String... packagesToExclude) Packages to exclude builder.packagesToScan
(String... packagesToScan) Packages to scan builder.pathsToExclude
(String... pathsToExclude) Paths to exclude builder.pathsToMatch
(String... pathsToMatch) Paths to match builder.producesToMatch
(String... producesToMatch) Produces to match builder.
-
Method Details
-
group
Group builder.- Parameters:
group
- the group- Returns:
- the builder
-
pathsToMatch
Paths to match builder.- Parameters:
pathsToMatch
- the paths to match- Returns:
- the builder
-
packagesToScan
Packages to scan builder.- Parameters:
packagesToScan
- the packages to scan- Returns:
- the builder
-
producesToMatch
Produces to match builder.- Parameters:
producesToMatch
- the produces to match- Returns:
- the builder
-
consumesToMatch
Consumes to match builder.- Parameters:
consumesToMatch
- the consumes to match- Returns:
- the builder
-
headersToMatch
Headers to match builder.- Parameters:
headersToMatch
- the headers to match- Returns:
- the builder
-
pathsToExclude
Paths to exclude builder.- Parameters:
pathsToExclude
- the paths to exclude- Returns:
- the builder
-
packagesToExclude
Packages to exclude builder.- Parameters:
packagesToExclude
- the packages to exclude- Returns:
- the builder
-
addOpenApiCustomizer
Add open api customiser builder.- Parameters:
openApiCustomizer
- the open api customiser- Returns:
- the builder
-
addOperationCustomizer
Add operation customizer builder.- Parameters:
operationCustomizer
- the operation customizer- Returns:
- the builder
-
addRouterOperationCustomizer
public GroupedOpenApi.Builder addRouterOperationCustomizer(RouterOperationCustomizer routerOperationCustomizer) Add router operation customizer builder- Parameters:
routerOperationCustomizer
- the router operation customizer- Returns:
- the builder
-
addOpenApiMethodFilter
Add method filter.- Parameters:
methodFilter
- an additional filter to apply to the matched methods- Returns:
- the builder
-
displayName
Display name builder.- Parameters:
displayName
- the display name- Returns:
- the builder
-
build
Build grouped open api.- Returns:
- the grouped open api
-