How do I specify multiple hosts in OpenAPI (Swagger)?

swagger openapi swagger-2.0
user2598740 picture user2598740 · Nov 14, 2016 · Viewed 11.1k times · Source

Right now my OpenAPI 2.0 YAML file has only one host URL:

host: petstore.test.com
basePath: /

Can I use multiple hosts like this?

host1: petstore.test.com
host2: petstore1.test.com
host3: petstore2.dev.com

Answer

Helen picture Helen · Nov 15, 2016

OpenAPI 2.0 (Swagger 2.0) only supports a single host with multiple schemes (HTTP/HTTPS/etc.), so you can effectively have two hosts that only vary in the scheme:

host: petstore.test.com
schemes:
  - http
  - https

The latest version, OpenAPI 3.0, supports multiple hosts with different schemes and base paths:

servers:
  - url: https://petstore.prd.com
    description: Production server

  - url: {scheme}://petstore.dev.com/subpath
    description: Development server
    templates:
      scheme:
        enum:
          - http
          - https
        default: https

For more examples, see this answer.

Related questions

How to describe this POST JSON request body in OpenAPI (Swagger)?

I have a POST request that uses the following JSON request body. How can I describe this request body using OpenAPI (Swagger)? { "testapi":{ "testapiContext":{ "messageId":"kkkk8", "messageDateTime":"2014-08-17T14:07:30+0530" }, "testapiBody":{ "cameraServiceRq":{ "osType":"android", "deviceType":"samsung555" } } } } So far I tried …

Read More
How to define an enum in OpenAPI (Swagger)?

Does anyone know how to define possible 'enum' values in an OpenAPI 2.0 definition so that they will be displayed in the Model tab of Swagger UI? Example here: https://petstore.swagger.io/#!/pet/addPet has an enum option for the …

Read More
Swagger/OpenAPI mock server

I have an API reference in a Swagger file. I want to create a very simple mock server, so that when I call e.g.: mymockurl.com/users it will return a predefined JSON (no need to connect to a …

Read More