Class OpenAPISupport

  • All Implemented Interfaces:

    public abstract class OpenAPISupport
    extends Object
    implements Service
    Provides an endpoint and supporting logic for returning an OpenAPI document that describes the endpoints handled by the server.

    The server can use the OpenAPISupport.Builder to set OpenAPI-related attributes. If the server uses none of these builder methods and does not provide a static openapi file, then the /openapi endpoint responds with a nearly-empty OpenAPI document.

    • Field Detail


        public static final String DEFAULT_WEB_CONTEXT
        Default path for serving the OpenAPI document.
        See Also:
        Constant Field Values

        public static final MediaType DEFAULT_RESPONSE_MEDIA_TYPE
        Default media type used in responses in absence of incoming Accept header.
    • Method Detail

      • configureEndpoint

        public void configureEndpoint​(Routing.Rules rules)
        Sets up the OpenAPI endpoint by adding routing to the specified rules set.
        rules - routing rules to be augmented with OpenAPI endpoint
      • webContext

        public String webContext()
        the web context setting for this service
      • prepareModel

        protected void prepareModel()
        Triggers preparation of the model from external code.
      • create

        public static OpenAPISupport create​(Config config)
        Creates a new OpenAPISupport instance using the 'openapi' portion of the provided Config object.
        config - Config object containing OpenAPI-related settings
        new OpenAPISupport instance created using the helidonConfig settings