Siapkan respons integrasi di API Gateway - APIGerbang Amazon

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

Siapkan respons integrasi di API Gateway

Untuk integrasi non-proxy, Anda harus menyiapkan setidaknya satu respons integrasi, dan menjadikannya respons default, untuk meneruskan hasil yang dikembalikan dari backend ke klien. Anda dapat memilih untuk melewati hasil apa adanya atau mengubah data respons integrasi ke data respons metode jika keduanya memiliki format yang berbeda.

Untuk integrasi proxy, API Gateway secara otomatis meneruskan output backend ke klien sebagai respons HTTP. Anda tidak menetapkan respons integrasi atau respons metode.

Untuk menyiapkan respons integrasi, Anda melakukan tugas wajib dan opsional berikut:

  1. Tentukan kode status HTTP dari respons metode yang data respons integrasi dipetakan. Ini wajib diisi.

  2. Tentukan ekspresi reguler untuk memilih output backend yang akan diwakili oleh respons integrasi ini. Jika Anda membiarkan ini kosong, responsnya adalah respons default yang digunakan untuk menangkap respons apa pun yang belum dikonfigurasi.

  3. Jika diperlukan, deklarasikan pemetaan yang terdiri dari pasangan nilai kunci untuk memetakan parameter respons integrasi yang ditentukan ke parameter respons metode yang diberikan.

  4. Jika perlu, tambahkan templat pemetaan tubuh untuk mengubah muatan respons integrasi yang diberikan menjadi muatan respons metode yang ditentukan.

  5. Jika diperlukan, tentukan cara menangani konversi tipe untuk muatan biner.

Respons integrasi adalah respons HTTP yang merangkum respons backend. Untuk titik akhir HTTP, respons backend adalah respons HTTP. Kode status respons integrasi dapat mengambil kode status yang dikembalikan ke backend, dan badan respons integrasi adalah payload yang dikembalikan ke backend. Untuk titik akhir Lambda, respons backend adalah output yang dikembalikan dari fungsi Lambda. Dengan integrasi Lambda, output fungsi Lambda dikembalikan sebagai respons. 200 OK Payload dapat berisi hasil sebagai data JSON, termasuk string JSON atau objek JSON, atau pesan kesalahan sebagai objek JSON. Anda dapat menetapkan ekspresi reguler ke properti SelectionPattern untuk memetakan respons kesalahan terhadap respons kesalahan HTTP yang sesuai. Untuk informasi selengkapnya tentang respons kesalahan fungsi Lambda, lihat. Menangani kesalahan Lambda di API Gateway Dengan integrasi proxy Lambda, fungsi Lambda harus mengembalikan output dari format berikut:

{
    statusCode: "...",            // a valid HTTP status code
    headers: { 
        custom-header: "..."      // any API-specific custom header
    },
    body: "...",                  // a JSON string.
    isBase64Encoded:  true|false  // for binary support
}

Tidak perlu memetakan respons fungsi Lambda ke respons HTTP yang tepat.

Untuk mengembalikan hasil ke klien, atur respons integrasi untuk meneruskan respons titik akhir melalui apa adanya ke respons metode yang sesuai. Atau Anda dapat memetakan data respons titik akhir ke data respons metode. Data respons yang dapat dipetakan mencakup kode status respons, parameter header respons, dan badan respons. Jika tidak ada respons metode yang ditentukan untuk kode status yang dikembalikan, API Gateway mengembalikan kesalahan 500. Untuk informasi selengkapnya, lihat Gunakan templat pemetaan untuk mengganti parameter API permintaan dan respons serta kode status.