Package org.springdoc.core

Class GroupedOpenApi

java.lang.Object
org.springdoc.core.GroupedOpenApi
public class GroupedOpenApi extends Object
The type Grouped open api.
Author:
bnasslahsen

  • Method Details

    • builder

      public static GroupedOpenApi.Builder builder()
      Builder builder.
      Returns:
      the builder

    • getProducesToMatch

      public List<String> getProducesToMatch()
      Gets produces to match.
      Returns:
      the produces to match

    • getHeadersToMatch

      public List<String> getHeadersToMatch()
      Gets headers to match.
      Returns:
      the headers to match

    • getConsumesToMatch

      public List<String> getConsumesToMatch()
      Gets consumes to match.
      Returns:
      the consumes to match

    • 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

    • getOpenApiMethodFilters

      public List<OpenApiMethodFilter> getOpenApiMethodFilters()
      Gets open api method filters.
      Returns:
      the open api method filters

    • getRouterOperationCustomizers

      public List<RouterOperationCustomizer> getRouterOperationCustomizers()
      Gets router operation customizers.
      Returns:
      the router operation customizers

    • getDisplayName

      public String getDisplayName()
      Gets display name.
      Returns:
      the display name

    • addAllOpenApiCustomizer

      public GroupedOpenApi addAllOpenApiCustomizer(Collection<? extends OpenApiCustomiser> openApiCustomizerCollection)
      Add all open api customizer grouped open api.
      Parameters:
      openApiCustomizerCollection - the open api customizer collection
      Returns:
      the grouped open api

    • addAllOperationCustomizer

      public GroupedOpenApi addAllOperationCustomizer(Collection<? extends OperationCustomizer> operationCustomizerCollection)
      Add all operation customizer grouped open api.
      Parameters:
      operationCustomizerCollection - the operation customizer collection
      Returns:
      the grouped open api

    • addAllOpenApiMethodFilter

      public GroupedOpenApi addAllOpenApiMethodFilter(Collection<? extends OpenApiMethodFilter> openApiMethodFilterCollection)
      Add all open api method filter grouped open api.
      Parameters:
      openApiMethodFilterCollection - the open api method filter collection
      Returns:
      the grouped open api