Serverオブジェクト

サーバーを表すオブジェクト。

固定フィールド

フィールド名	タイプ	説明
URL	string	必須。ターゲットホストへの URL。この URL はサーバー変数をサポートしており、ホストの場所が OpenAPI ドキュメントが提供される場所に対して相対的なものであることを示すために、相対的な URL であってもよい (MAY)。変数の置換は、変数が{括弧内で指定されている場合に行われます}。
説明	string	URL で指定されたホストを説明するオプションの文字列。CommonMark 構文はリッチ テキスト表現に使用できます (MAY)。
変数	Map[ string,サーバー変数オブジェクト]	変数名とその値の間のマップ。この値は、サーバーの URL テンプレートでの置換に使用されます。

このオブジェクトは、仕様拡張機能を使用して拡張できます。

Serverオブジェクトの例

単一サーバーは次のように記述されます。

{
  "url": "https://development.gigantic-server.com/v1",
  "description": "Development server"
}

url: https://development.gigantic-server.com/v1
description: Development server

以下は、たとえば OpenAPI オブジェクトのservers で複数のサーバーを記述する方法を示しています。

{
  "servers": [
    {
      "url": "https://development.gigantic-server.com/v1",
      "description": "Development server"
    },
    {
      "url": "https://staging.gigantic-server.com/v1",
      "description": "Staging server"
    },
    {
      "url": "https://api.gigantic-server.com/v1",
      "description": "Production server"
    }
  ]
}

servers:
  - url: https://development.gigantic-server.com/v1
    description: Development server
  - url: https://staging.gigantic-server.com/v1
    description: Staging server
  - url: https://api.gigantic-server.com/v1
    description: Production server

以下に、変数をサーバー構成に使用する方法を示します。

{
  "servers": [
    {
      "url": "https://{username}.gigantic-server.com:{port}/{basePath}",
      "description": "The production API server",
      "variables": {
        "username": {
          "default": "demo",
          "description": "this value is assigned by the service provider, in this example `gigantic-server.com`"
        },
        "port": {
          "enum": [
            "8443",
            "443"
          ],
          "default": "8443"
        },
        "basePath": {
          "default": "v2"
        }
      }
    }
  ]
}

servers:
  - url: https://{username}.gigantic-server.com:{port}/{basePath}
    description: The production API server
    variables:
      username:
        # note! no enum here means it is an open value
        default: demo
        description: this value is assigned by the service provider, in this example `gigantic-server.com`
      port:
        enum:
          - '8443'
          - '443'
        default: '8443'
      basePath:
        # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2`
        default: v2

サーバー変数オブジェクト

サーバー URL テンプレート置換のサーバー変数を表すオブジェクト。

固定フィールド

フィールド名	タイプ	説明
列挙型	[ string]	置換オプションが限られたセットからのものである場合に使用される文字列値の列挙。配列は空であってはなりません。
デフォルト	string	必須。置換に使用するデフォルト値。代替値が指定されない場合に送信されるものとします。この場合、パラメータ値はオプションであるため、この動作はスキーマ オブジェクトのデフォルト値の処理とは異なることに注意してください。が定義されている場合enum、その値は列挙型の値に存在する必要があります。
説明	string	サーバー変数の説明 (オプション)。CommonMark 構文はリッチ テキスト表現に使用できます (MAY)。

このオブジェクトは、仕様拡張機能を使用して拡張できます。