GroupedOpenApi.Builder (springdoc-openapi-common 1.8.0 API)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GroupedOpenApi.Builder`	`addOpenApiCustomiser(OpenApiCustomiser openApiCustomiser)` Add open api customiser builder.
`GroupedOpenApi.Builder`	`addOpenApiMethodFilter(OpenApiMethodFilter methodFilter)` Add method filter.
`GroupedOpenApi.Builder`	`addOperationCustomizer(OperationCustomizer operationCustomizer)` Add operation customizer builder.
`GroupedOpenApi.Builder`	`addRouterOperationCustomizer(RouterOperationCustomizer routerOperationCustomizer)` Add router operation customizer builder
`GroupedOpenApi`	`build()` Build grouped open api.
`GroupedOpenApi.Builder`	`consumesToMatch(String... consumesToMatch)` Consumes to match builder.
`GroupedOpenApi.Builder`	`displayName(String displayName)` Display name builder.
`GroupedOpenApi.Builder`	`group(String group)` Group builder.
`GroupedOpenApi.Builder`	`headersToMatch(String... headersToMatch)` Headers to match builder.
`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)` Produces to match builder.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - 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)
```
    Produces to match builder.
    
    Parameters:
    
    producesToMatch - the produces to match
    
    Returns:
    
    the builder
  - consumesToMatch
```
public GroupedOpenApi.Builder consumesToMatch(String... consumesToMatch)
```
    Consumes to match builder.
    
    Parameters:
    
    consumesToMatch - the consumes to match
    
    Returns:
    
    the builder
  - headersToMatch
```
public GroupedOpenApi.Builder headersToMatch(String... headersToMatch)
```
    Headers to match builder.
    
    Parameters:
    
    headersToMatch - the headers to match
    
    Returns:
    
    the builder
  - 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
  - addRouterOperationCustomizer
```
public GroupedOpenApi.Builder addRouterOperationCustomizer(RouterOperationCustomizer routerOperationCustomizer)
```
    Add router operation customizer builder
    
    Parameters:
    
    routerOperationCustomizer - the router operation customizer
    
    Returns:
    
    the builder
  - addOpenApiMethodFilter
```
public GroupedOpenApi.Builder addOpenApiMethodFilter(OpenApiMethodFilter methodFilter)
```
    Add method filter.
    
    Parameters:
    
    methodFilter - an additional filter to apply to the matched methods
    
    Returns:
    
    the builder
  - displayName
```
public GroupedOpenApi.Builder displayName(String displayName)
```
    Display name builder.
    
    Parameters:
    
    displayName - the display name
    
    Returns:
    
    the builder
  - build
```
public GroupedOpenApi build()
```
    Build grouped open api.
    
    Returns:
    
    the grouped open api

Class GroupedOpenApi.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

group

pathsToMatch

packagesToScan

producesToMatch

consumesToMatch

headersToMatch

pathsToExclude

packagesToExclude

addOpenApiCustomiser

addOperationCustomizer

addRouterOperationCustomizer

addOpenApiMethodFilter

displayName

build