servers

A server object to be used by the target operation.

Type: List of Server Objects

Field Name Type Description
url string 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 are made when a variable is named in { curly braces }.
description string An optional string describing the host designated by the URL.
variables Map[string, Server Variable Object] A map between a variable name and its value. The value is used for substitution in the server's URL template.

Servers can be defined at the definition root and also at the path item level. The path item servers, if defined, take precedence over the definition root servers.

Visuals

Example with a single server

The following example is of a single server.

Copy
Copied
servers:
  - url: https://api.redocly.com

Example with two servers

Copy
Copied
servers:
  - url: https://api.redocly.com
  - url: https://sandbox.redocly.com

two servers

Example with description

Copy
Copied
servers:
  - url: https://api.redocly.com
    description: Production
  - url: https://sandbox.redocly.com
    description: Sandbox

two servers with descriptions

The servers can be displayed in the center panel by setting the pathInMiddlePanel: true option.

server urls with descriptions

Types

  • ServerList
  • Server
  • ServerVariable

server-list

ServerListServerServerVariablehashas