Siapkan integrasi tiruan di API Gateway

Amazon API Gateway mendukung integrasi tiruan untuk metode API. Fitur ini memungkinkan pengembang API untuk menghasilkan respons API dari API Gateway secara langsung, tanpa perlu backend integrasi. Sebagai pengembang API, Anda dapat menggunakan fitur ini untuk membuka blokir tim dependen yang perlu bekerja dengan API sebelum pengembangan proyek selesai. Anda juga dapat menggunakan fitur ini untuk menyediakan halaman landing untuk API Anda, yang dapat memberikan ikhtisar dan navigasi ke API Anda. Untuk contoh halaman arahan seperti itu, lihat permintaan integrasi dan respons metode GET pada sumber daya root dari contoh API yang dibahasTutorial: Buat REST API dengan mengimpor contoh.

Sebagai pengembang API, Anda memutuskan bagaimana API Gateway merespons permintaan integrasi tiruan. Untuk ini, Anda mengonfigurasi permintaan integrasi metode dan respons integrasi untuk mengaitkan respons dengan kode status tertentu. Untuk metode dengan integrasi tiruan untuk mengembalikan 200 respons, konfigurasikan template pemetaan badan permintaan integrasi untuk mengembalikan yang berikut ini.

{"statusCode": 200}

Konfigurasikan respons 200 integrasi untuk memiliki template pemetaan tubuh berikut, misalnya:

{
    "statusCode": 200,
    "message": "Go ahead without me."
}

Demikian pula, agar metode mengembalikan, misalnya, respons 500 kesalahan, siapkan templat pemetaan badan permintaan integrasi untuk mengembalikan yang berikut ini.

{"statusCode": 500}

Siapkan respons 500 integrasi dengan, misalnya, templat pemetaan berikut:

{
    "statusCode": 500,
    "message": "The invoked method is not supported on the API resource."
}

Atau, Anda dapat meminta metode integrasi tiruan mengembalikan respons integrasi default tanpa menentukan templat pemetaan permintaan integrasi. Respons integrasi default adalah respons dengan regex status HTTP yang tidak ditentukan. Pastikan perilaku passthrough yang sesuai ditetapkan.

catatan

Integrasi tiruan tidak dimaksudkan untuk mendukung template respons besar. Jika Anda membutuhkannya untuk kasus penggunaan Anda, Anda harus mempertimbangkan untuk menggunakan integrasi Lambda sebagai gantinya.

Dengan menggunakan templat pemetaan permintaan integrasi, Anda dapat menyuntikkan logika aplikasi untuk memutuskan respons integrasi tiruan mana yang akan dikembalikan berdasarkan kondisi tertentu. Misalnya, Anda dapat menggunakan parameter scope kueri pada permintaan yang masuk untuk menentukan apakah akan mengembalikan respons yang berhasil atau respons kesalahan:

{
  #if( $input.params('scope') == "internal" )
    "statusCode": 200
  #else
    "statusCode": 500
  #end
}

Dengan cara ini, metode integrasi tiruan memungkinkan panggilan internal dilakukan sambil menolak jenis panggilan lain dengan respons kesalahan.

Di bagian ini, kami menjelaskan cara menggunakan konsol API Gateway untuk mengaktifkan integrasi tiruan untuk metode API.

Topik

• Aktifkan integrasi tiruan menggunakan konsol API Gateway