Contoh model data dan templat pemetaan untuk API Gateway - APIGerbang Amazon
Contoh album fotoContoh artikel berita

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

Contoh model data dan templat pemetaan untuk API Gateway

Bagian berikut memberikan contoh model dan templat pemetaan yang dapat digunakan sebagai titik awal untuk Anda sendiri APIs di API Gateway. Untuk informasi selengkapnya tentang transformasi data, lihatTemplate pemetaan untuk REST APIs. Untuk informasi selengkapnya tentang model data, lihatModel data untuk REST APIs.

Contoh album foto

Contoh berikut menunjukkan album foto API di API Gateway. Kami menyediakan contoh transformasi data, model tambahan, dan templat pemetaan.

Contoh transformasi data

Contoh berikut menunjukkan bagaimana Anda dapat mengubah data input tentang foto dengan menggunakan template pemetaan Velocity Template Language (VTL). Untuk informasi lebih lanjut tentang Bahasa Template Velocity, lihat Apache Velocity - Referensi. VTL

Contoh berikut adalah input data ke permintaan integrasi.

{
  "photos": {
    "page": 1,
    "pages": "1234",
    "perpage": 100,
    "total": "123398",
    "photo": [
      {
        "id": "12345678901",
        "owner": "23456789@A12",
        "photographer_first_name" : "Saanvi",
        "photographer_last_name" : "Sarkar",
        "secret": "abc123d456",
        "server": "1234",
        "farm": 1,
        "title": "Sample photo 1",
        "ispublic": true,
        "isfriend": false,
        "isfamily": false
      },
      {
        "id": "23456789012",
        "owner": "34567890@B23",
        "photographer_first_name" : "Richard",
        "photographer_last_name" : "Roe",
        "secret": "bcd234e567",
        "server": "2345",
        "farm": 2,
        "title": "Sample photo 2",
        "ispublic": true,
        "isfriend": false,
        "isfamily": false
      }
    ]
  }
}

Contoh berikut adalah template pemetaan untuk mengubah data foto.

#set($inputRoot = $input.path('$'))
{
  "photos": [
#foreach($elem in $inputRoot.photos.photo)
    {
      "id": "$elem.id",
      "photographedBy": "$elem.photographer_first_name $elem.photographer_last_name",
      "title": "$elem.title",
      "ispublic": $elem.ispublic,
      "isfriend": $elem.isfriend,
      "isfamily": $elem.isfamily
    }#if($foreach.hasNext),#end
		
#end
  ]
}

Contoh berikut adalah data output dari transformasi.

{
  "photos": [
    {
      "id": "12345678901",
      "photographedBy": "Saanvi Sarkar",
      "title": "Sample photo 1",
      "ispublic": true,
      "isfriend": false,
      "isfamily": false
    },		
    {
      "id": "23456789012",
      "photographedBy": "Richard Roe",
      "title": "Sample photo 2",
      "ispublic": true,
      "isfriend": false,
      "isfamily": false
    }		
  ]
}

Model masukan untuk data foto

Anda dapat menentukan model untuk data input Anda. Model input ini mengharuskan Anda mengunggah satu foto, dan menentukan minimal 10 foto untuk setiap halaman. Anda dapat menggunakan model masukan ini untuk menghasilkan SDK atau mengaktifkan validasi permintaan untuk AndaAPI. 

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PhotosInputModel",
  "type": "object",
  "properties": {
    "photos": {
      "type": "object",
      "required" : [
      "photo"
      ],
      "properties": {
        "page": { "type": "integer" },
        "pages": { "type": "string" },
        "perpage": { "type": "integer", "minimum" : 10 },
        "total": { "type": "string" },
        "photo": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": { "type": "string" },
              "owner": { "type": "string" },
              "photographer_first_name" : {"type" : "string"},
              "photographer_last_name" : {"type" : "string"},
              "secret": { "type": "string" },
              "server": { "type": "string" },
              "farm": { "type": "integer" },
              "title": { "type": "string" },
              "ispublic": { "type": "boolean" },
              "isfriend": { "type": "boolean" },
              "isfamily": { "type": "boolean" }
            }
          }
        }
      }
    }
  }
}

Model keluaran untuk data foto

Anda dapat menentukan model untuk data keluaran Anda. Anda dapat menggunakan model ini untuk model respons metode, yang diperlukan saat Anda membuat yang diketik dengan kuat SDK untuk. API Hal ini menyebabkan output dilemparkan ke kelas yang sesuai di Java atau Objective-C.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PhotosOutputModel",
  "type": "object",
  "properties": {
    "photos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "photographedBy": { "type": "string" },
          "title": { "type": "string" },
          "ispublic": { "type": "boolean" },
          "isfriend": { "type": "boolean" },
          "isfamily": { "type": "boolean" }
        }
      }
    }
  }
}

Template pemetaan masukan untuk data foto

Anda dapat menentukan template pemetaan untuk memodifikasi data input. Anda dapat memodifikasi data input untuk integrasi fungsi atau respons integrasi lebih lanjut.

#set($inputRoot = $input.path('$'))
{
  "photos": {
    "page": $inputRoot.photos.page,
    "pages": "$inputRoot.photos.pages",
    "perpage": $inputRoot.photos.perpage,
    "total": "$inputRoot.photos.total",
    "photo": [
#foreach($elem in $inputRoot.photos.photo)
      {
        "id": "$elem.id",
        "owner": "$elem.owner",
        "photographer_first_name" : "$elem.photographer_first_name",
        "photographer_last_name" : "$elem.photographer_last_name",
        "secret": "$elem.secret",
        "server": "$elem.server",
        "farm": $elem.farm,
        "title": "$elem.title",
        "ispublic": $elem.ispublic,
        "isfriend": $elem.isfriend,
        "isfamily": $elem.isfamily
      }#if($foreach.hasNext),#end
			
#end
    ]
  }
}

Contoh artikel berita

Contoh berikut menunjukkan artikel berita API di API Gateway. Kami menyediakan contoh transformasi data, model tambahan, dan templat pemetaan.

Contoh transformasi data

Contoh berikut menunjukkan bagaimana Anda dapat mengubah data masukan tentang artikel berita dengan menggunakan template pemetaan Velocity Template Language (VTL). Untuk informasi lebih lanjut tentang Bahasa Template Velocity, lihat Apache Velocity - Referensi. VTL

Contoh berikut adalah input data ke permintaan integrasi.

{
  "count": 1,
  "items": [
    {
      "last_updated_date": "2015-04-24",
      "expire_date": "2016-04-25",
      "author_first_name": "John",
      "description": "Sample Description",
      "creation_date": "2015-04-20",
      "title": "Sample Title",
      "allow_comment": true,
      "author": {
        "last_name": "Doe",
        "email": "johndoe@example.com",
        "first_name": "John"
      },
      "body": "Sample Body",
      "publish_date": "2015-04-25",
      "version": "1",
      "author_last_name": "Doe",
      "parent_id": 2345678901,
      "article_url": "http://www.example.com/articles/3456789012"
    }
  ],
  "version": 1
}

Contoh berikut adalah template pemetaan untuk mengubah data artikel berita.

#set($inputRoot = $input.path('$'))
{
  "count": $inputRoot.count,
  "items": [
#foreach($elem in $inputRoot.items)
    {
      "creation_date": "$elem.creation_date",
      "title": "$elem.title",
      "author": "$elem.author.first_name $elem.author.last_name",
      "body": "$elem.body",
      "publish_date": "$elem.publish_date",
      "article_url": "$elem.article_url"
    }#if($foreach.hasNext),#end

#end
  ],
  "version": $inputRoot.version
}

Contoh berikut adalah data output dari transformasi.

{
  "count": 1,
  "items": [
    {
      "creation_date": "2015-04-20",
      "title": "Sample Title",
      "author": "John Doe",
      "body": "Sample Body",
      "publish_date": "2015-04-25",
      "article_url": "http://www.example.com/articles/3456789012"
    }
  ],
  "version": 1
}

Model masukan untuk data berita

Anda dapat menentukan model untuk data input Anda. Model input ini mengharuskan artikel berita berisiURL, judul, dan isi. Anda dapat menggunakan model masukan ini untuk menghasilkan SDK atau mengaktifkan validasi permintaan untuk AndaAPI. 

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "NewsArticleInputModel",
  "type": "object",
  "properties": {
    "count": { "type": "integer" },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
      "article_url",
      "title",
      "body"
      ],
        "properties": {
          "last_updated_date": { "type": "string" },
          "expire_date": { "type": "string" },
          "author_first_name": { "type": "string" },
          "description": { "type": "string" },
          "creation_date": { "type": "string" },
          "title": { "type": "string" },
          "allow_comment": { "type": "boolean" },
          "author": {
            "type": "object",
            "properties": {
              "last_name": { "type": "string" },
              "email": { "type": "string" },
              "first_name": { "type": "string" }
            }
          },
          "body": { "type": "string" },
          "publish_date": { "type": "string" },
          "version": { "type": "string" },
          "author_last_name": { "type": "string" },
          "parent_id": { "type": "integer" },
          "article_url": { "type": "string" }
        }
      }
    },
    "version": { "type": "integer" }
  }
}

Model keluaran untuk data berita

Anda dapat menentukan model untuk data keluaran Anda. Anda dapat menggunakan model ini untuk model respons metode, yang diperlukan saat Anda membuat yang diketik dengan kuat SDK untuk. API Hal ini menyebabkan output dilemparkan ke kelas yang sesuai di Java atau Objective-C.

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "PhotosOutputModel",
  "type": "object",
  "properties": {
    "photos": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "photographedBy": { "type": "string" },
          "title": { "type": "string" },
          "ispublic": { "type": "boolean" },
          "isfriend": { "type": "boolean" },
          "isfamily": { "type": "boolean" }
        }
      }
    }
  }
}

Template pemetaan masukan untuk data berita

Anda dapat menentukan template pemetaan untuk memodifikasi data input. Anda dapat memodifikasi data input untuk integrasi fungsi atau respons integrasi lebih lanjut.

#set($inputRoot = $input.path('$'))
{
  "count": $inputRoot.count,
  "items": [
#foreach($elem in $inputRoot.items)
    {
      "last_updated_date": "$elem.last_updated_date",
      "expire_date": "$elem.expire_date",
      "author_first_name": "$elem.author_first_name",
      "description": "$elem.description",
      "creation_date": "$elem.creation_date",
      "title": "$elem.title",
      "allow_comment": "$elem.allow_comment",
      "author": {
        "last_name": "$elem.author.last_name",
        "email": "$elem.author.email",
        "first_name": "$elem.author.first_name"
      },
      "body": "$elem.body",
      "publish_date": "$elem.publish_date",
      "version": "$elem.version",
      "author_last_name": "$elem.author_last_name",
      "parent_id": $elem.parent_id,
      "article_url": "$elem.article_url"
    }#if($foreach.hasNext),#end

#end
  ],
  "version": $inputRoot.version
}