x-amazon-apigateway-documentation オブジェクト

API Gateway にインポートするドキュメントパーツを定義します。このオブジェクトは、DocumentationPart インスタンスの配列を含む JSON オブジェクトです。

プロパティ名	タイプ	説明
documentationParts	Array	エクスポートまたはインポートする DocumentationPart インスタンスの配列。
version	String	エクスポートするドキュメントパーツのスナップショットのバージョン識別子。

x-amazon-apigateway-documentation の例

OpenAPI への API Gateway 拡張の次の例では、API Gateway で API にインポートまたはエクスポートする DocumentationParts インスタンスを定義します。

{ ...
  "x-amazon-apigateway-documentation": {
    "version": "1.0.3",
    "documentationParts": [
       {
         "location": {
           "type": "API"
       },
        "properties": {
          "description": "API description",
          "info": {
            "description": "API info description 4",
            "version": "API info version 3"
          }
        }
      },
      {
         … // Another DocumentationPart instance
      }
    ]
  }
}