Module io.helidon.openapi
Package io.helidon.openapi

Class SEOpenAPISupportBuilder

java.lang.Object
io.helidon.openapi.OpenAPISupport.Builder<SEOpenAPISupportBuilder>
io.helidon.openapi.SEOpenAPISupportBuilder
All Implemented Interfaces:
io.helidon.common.Builder<SEOpenAPISupportBuilder,OpenAPISupport>, Supplier<OpenAPISupport>
public final class SEOpenAPISupportBuilder extends OpenAPISupport.Builder<SEOpenAPISupportBuilder>
Builds OpenAPISupport in a Helidon SE environment.

The builder mostly delegates to an instance of Helidon's OpenAPIConfigImpl.Builder which in turn prepares a smallrye OpenApiConfig which is what the smallrye implementation uses to control its behavior.

  • Constructor Details

    • SEOpenAPISupportBuilder

      public SEOpenAPISupportBuilder()

  • Method Details

    • config

      public SEOpenAPISupportBuilder config(Config config)
      Assigns various OpenAPI settings from the specified openapi Config object.

      The Config object can specify web-context and static-file in addition to settings supported by OpenAPIConfigImpl.Builder.

      Overrides:
      config in class OpenAPISupport.Builder<SEOpenAPISupportBuilder>
      Parameters:
      config - the OpenAPI Config object possibly containing settings
      Returns:
      updated builder instance
      Throws:
      NullPointerException - if the provided Config is null

    • build

      public io.helidon.openapi.SEOpenAPISupport build()

    • openAPIConfig

      public io.smallrye.openapi.api.OpenApiConfig openAPIConfig()
      Description copied from class: OpenAPISupport.Builder
      Returns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.
      Specified by:
      openAPIConfig in class OpenAPISupport.Builder<SEOpenAPISupportBuilder>
      Returns:
      OpenApiConfig conveying how OpenAPI should behave

    • modelReader

      public SEOpenAPISupportBuilder modelReader(String className)
      Sets the app-provided model reader class.
      Parameters:
      className - name of the model reader class
      Returns:
      updated builder instance

    • filter

      public SEOpenAPISupportBuilder filter(String className)
      Set the app-provided OpenAPI model filter class.
      Parameters:
      className - name of the filter class
      Returns:
      updated builder instance

    • servers

      public SEOpenAPISupportBuilder servers(String serverList)
      Sets the servers which offer the endpoints in the OpenAPI document.
      Parameters:
      serverList - comma-separated list of servers
      Returns:
      updated builder instance

    • addOperationServer

      public SEOpenAPISupportBuilder addOperationServer(String operationID, String operationServer)
      Adds an operation server for a given operation ID.
      Parameters:
      operationID - operation ID to which the server corresponds
      operationServer - name of the server to add for this operation
      Returns:
      updated builder instance

    • addPathServer

      public SEOpenAPISupportBuilder addPathServer(String path, String pathServer)
      Adds a path server for a given path.
      Parameters:
      path - path to which the server corresponds
      pathServer - name of the server to add for this path
      Returns:
      updated builder instance