swagger/OpenAPI 3.0で本番と検証用のURLを明示的に示す

ずっと記載分けができないものだと思っていた。

書き方

下記のドキュメントにある。

API Server and Base Path | Swagger

serversというセクションがあり、そこは配列指定できるのでそちらを使う。この書き方にすると、SwaggerUIでもアクセス先切り替えができる。

例

servers:
  - url: https://example.com/produciton
    description: 本番向けサーバ
  - url: https://example.com/staging
    description: テスト用検証向けサーバ

関連リンク

• OpenAPI Specification 3.0 チートシート - 朝日ネット　技術者ブログ