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

Interface OpenApiUi.Builder<B extends OpenApiUi.Builder<B,​T>,​T extends OpenApiUi>

  • Type Parameters:
    T - type of the OpenApiUi to be build
    B - type of the builder for T
    All Superinterfaces:
    Builder<T>, Supplier<T>
    All Known Implementing Classes:
    OpenApiUiBase.Builder
    Enclosing interface:
    OpenApiUi
    public static interface OpenApiUi.Builder<B extends OpenApiUi.Builder<B,​T>,​T extends OpenApiUi>
extends Builder<T>
    Builder for an OpenApiUi.

    • Field Detail

      • OPTIONS_CONFIG_KEY

        static final String OPTIONS_CONFIG_KEY
        Config key for implementation-dependent options settings.
        See Also:
        Constant Field Values

      • WEB_CONTEXT_CONFIG_KEY

        static final String WEB_CONTEXT_CONFIG_KEY
        Config key for specifying the entire web context where the UI responds.
        See Also:
        Constant Field Values

    • Method Detail

      • options

        B options​(Map<String,​String> options)
        Sets implementation-specific UI options.
        Parameters:
        options - the options to set for the UI
        Returns:
        updated builder

      • isEnabled

        B isEnabled​(boolean isEnabled)
        Sets whether the UI should be enabled.
        Parameters:
        isEnabled - true/false
        Returns:
        updated builder

      • webContext

        B webContext​(String webContext)
        Sets the entire web context (not just the suffix) where the UI response.
        Parameters:
        webContext - entire web context (path) where the UI responds
        Returns:
        updated builder

      • config

        default B config​(Config uiConfig)
        Updates the builder using the specified config node at "ui" within the "openapi" config section.
        Parameters:
        uiConfig - config node containing the UI settings
        Returns:
        updated builder

      • identity

        default B identity()
        Returns:
        correctly-typed self

      • documentPreparer

        B documentPreparer​(Function<MediaType,​String> documentPreparer)
        Assigns how the OpenAPI UI can obtain a formatted document for a given media type.

        Developers typically do not invoke this method. Helidon invokes it internally.

        Parameters:
        documentPreparer - the function for obtaining the formatted document
        Returns:
        updated builder

      • openApiSupportWebContext

        B openApiSupportWebContext​(String openApiWebContext)
        Assigns the web context the OpenAPISupport instance uses.

        Developers typically do not invoke this method. Helidon invokes it internally.

        Parameters:
        openApiWebContext - the web context used by the OpenAPISupport service
        Returns:
        updated builder

      • build

        default OpenApiUi build​(Function<MediaType,​String> documentPreparer,
                        String openAPIWebContext)
        Creates a new OpenApiUi from the builder.
        Parameters:
        documentPreparer - function which converts a MediaType into the corresponding expression of the OpenAPI document
        openAPIWebContext - web context for the OpenAPI instance
        Returns:
        new OpenApiUi