Interface ServerObject

An object representing a Server.

See

https://spec.openapis.org/oas/latest.html#server-object

interface ServerObject {
    description?: string;
    url: string;
    variables?: Record<string, ServerVariableObject>;
}

Hierarchy (view full)

Properties

description? url variables?

Properties

Optional description

description?: string

An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.

url

url: string

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}.

Optional variables

variables?: Record<string, ServerVariableObject>

A map between a variable name and its value. The value is used for substitution in the server’s URL template.

Settings

Member Visibility

Theme

On This Page

descriptionurlvariables