Package org.springdoc.core.models

Class GroupedOpenApi.Builder

java.lang.Object
org.springdoc.core.models.GroupedOpenApi.Builder
Enclosing class:
GroupedOpenApi
public static class GroupedOpenApi.Builder extends Object
The type Builder.
Author:
bnasslahsen

  • Method Details

    • 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

    • addOpenApiCustomizer

      public GroupedOpenApi.Builder addOpenApiCustomizer(OpenApiCustomizer openApiCustomizer)
      Add open api customiser builder.
      Parameters:
      openApiCustomizer - 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

    • 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