View a markdown version of this page

objek dokumentasi x-amazon-apigateway- - Amazon API Gateway
contoh dokumentasi x-amazon-apigateway-

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

objek dokumentasi x-amazon-apigateway-

Mendefinisikan bagian dokumentasi yang akan diimpor ke API Gateway. Objek ini adalah objek JSON yang berisi array DocumentationPart instance.

Nama properti Tipe Deskripsi
documentationParts Array

Array dari DocumentationPart instance yang diekspor atau diimpor.
version String

Pengidentifikasi versi snapshot dari bagian dokumentasi yang diekspor.

contoh dokumentasi x-amazon-apigateway-

Contoh ekstensi API Gateway ke OpenAPI berikut mendefinisikan DocumentationParts instance yang akan diimpor ke atau diekspor dari API di API Gateway. 

{ ...
  "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
      }
    ]
  }
}