API Explorer - Server variables

Server variables enable API Explorer users to customize the request server with predefined enums or custom strings. It’s useful to specify a server region or a client specific instance, for example.

Variables are defined in a server object:

servers:
  - url: https://{region}.bump.sh/{docId}
    description: The production API server
    variables:
      docId:
        description: Can be found in your documentation settings.
      region:
        enum:
          - "east-eu"
          - "west-eu"
        default: "east-eu"

In this example, two variables were added:

• docId is a string, and a description has been defined to help the API user find its value,
• region is an enumerated list, with east-eu being the default value.

The API Explorer renders each variable accordingly.

Learn more about it in our help center

Any feedback on this feature? We’re happy to hear them! Say hi at hello@bump.sh.