Package io.muserver.openapi

Class ServerObjectBuilder

  • public class ServerObjectBuilder
extends java.lang.Object
    An object representing a Server.

    • Constructor Detail

      • ServerObjectBuilder

        public ServerObjectBuilder()

    • Method Detail

      • withUrl

        public ServerObjectBuilder withUrl​(java.lang.String url)
        Parameters:
        url - REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.
        Returns:
        The current builder

      • withDescription

        public ServerObjectBuilder withDescription​(java.lang.String description)
        Parameters:
        description - An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
        Returns:
        The current builder

      • withVariables

        public ServerObjectBuilder withVariables​(java.util.Map<java.lang.String,​ServerVariableObject> variables)
        Parameters:
        variables - A map between a variable name and its value. The value is used for substitution in the server's URL template.
        Returns:
        The current builder