x-amazon-apigateway-documentation objek - APIGerbang Amazon
x-amazon-apigateway-documentation contoh

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

x-amazon-apigateway-documentation objek

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

Nama properti Tipe Deskripsi
documentationParts Array

Array DocumentationPart instance yang diekspor atau diimpor.
version String

Pengidentifikasi versi snapshot dari bagian dokumentasi yang diekspor.

x-amazon-apigateway-documentation contoh

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

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