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

Integrasi proxy Lambda di Gateway API

Bagian berikut menunjukkan cara menggunakan integrasi proxy Lambda.

Memahami API integrasi proxy Gateway Lambda

Integrasi proxy Amazon API Gateway Lambda adalah mekanisme yang sederhana, kuat, dan gesit untuk membangun API dengan penyiapan satu metode. API Integrasi proxy Lambda memungkinkan klien untuk memanggil satu fungsi Lambda di backend. Fungsi ini mengakses banyak sumber daya atau fitur AWS layanan lain, termasuk memanggil fungsi Lambda lainnya.

Dalam integrasi proxy Lambda, ketika klien mengirimkan API permintaan, API Gateway meneruskan ke fungsi Lambda terintegrasi objek peristiwa, kecuali bahwa urutan parameter permintaan tidak dipertahankan. Data permintaan ini mencakup header permintaan, parameter string kueri, variabel URL jalur, payload, dan data API konfigurasi. Data konfigurasi dapat mencakup nama tahap penyebaran saat ini, variabel tahap, identitas pengguna, atau konteks otorisasi (jika ada). Fungsi backend Lambda mem-parsing data permintaan yang masuk untuk menentukan respons yang dikembalikan. Agar API Gateway meneruskan output Lambda sebagai API respons terhadap klien, fungsi Lambda harus mengembalikan hasilnya dalam format ini.

Karena API Gateway tidak terlalu banyak campur tangan antara klien dan fungsi Lambda backend untuk integrasi proxy Lambda, klien dan fungsi Lambda terintegrasi dapat beradaptasi dengan perubahan satu sama lain tanpa merusak pengaturan integrasi yang ada dari. API Untuk mengaktifkan ini, klien harus mengikuti protokol aplikasi yang diberlakukan oleh fungsi Lambda backend.

Anda dapat mengatur integrasi proxy Lambda untuk metode apa punAPI. Tetapi integrasi proxy Lambda lebih kuat ketika dikonfigurasi untuk API metode yang melibatkan sumber daya proxy generik. Sumber daya proxy generik dapat dilambangkan dengan variabel jalur template khusus, placeholder metode catch-all {proxy+}ANY, atau keduanya. Klien dapat meneruskan input ke fungsi Lambda backend dalam permintaan masuk sebagai parameter permintaan atau muatan yang berlaku. Parameter permintaan termasuk header, variabel URL jalur, parameter string kueri, dan payload yang berlaku. Fungsi Lambda terintegrasi memverifikasi semua sumber input sebelum memproses permintaan dan menanggapi klien dengan pesan kesalahan yang berarti jika ada input yang diperlukan yang hilang.

Saat memanggil API metode yang terintegrasi dengan HTTP metode generik ANY dan sumber daya generik{proxy+}, klien mengirimkan permintaan dengan HTTP metode tertentu sebagai pengganti. ANY Klien juga menentukan URL jalur tertentu, bukan{proxy+}, dan menyertakan header yang diperlukan, parameter string kueri, atau muatan yang berlaku.

Daftar berikut merangkum perilaku runtime dari berbagai API metode dengan integrasi proxy Lambda:

Baik sumber daya proxy {proxy+} dan sumber daya kustom {custom} dinyatakan sebagai variabel jalur templat. Namun {proxy+} dapat merujuk ke sumber daya apa pun di sepanjang hierarki jalur, sementara {custom} mengacu pada segmen jalur tertentu saja. Misalnya, toko kelontong mungkin mengatur inventaris produk online-nya berdasarkan nama departemen, kategori produksi, dan jenis produk. Situs web toko kelontong kemudian dapat mewakili produk yang tersedia dengan variabel jalur template berikut dari sumber daya khusus:. /{department}/{produce-category}/{product-type} Misalnya, apel diwakili oleh /produce/fruit/apple dan wortel oleh/produce/vegetables/carrot. Ini juga dapat digunakan /{proxy+} untuk mewakili departemen apa pun, kategori produk apa pun, atau jenis produk apa pun yang dapat dicari pelanggan saat berbelanja di toko online. Misalnya, /{proxy+} dapat merujuk ke salah satu item berikut:

Untuk memungkinkan pelanggan mencari produk apa pun yang tersedia, kategori produksinya, dan departemen toko terkait, Anda dapat mengekspos satu metode GET /{proxy+} dengan izin hanya-baca. Demikian pula, untuk memungkinkan supervisor memperbarui inventaris produce departemen, Anda dapat mengatur metode tunggal lain PUT /produce/{proxy+} dengan izin baca/tulis. Untuk memungkinkan kasir memperbarui total sayuran yang sedang berjalan, Anda dapat mengatur POST /produce/vegetables/{proxy+} metode dengan izin baca/tulis. Untuk membiarkan manajer toko melakukan tindakan apa pun yang mungkin pada produk apa pun yang tersedia, pengembang toko online dapat mengekspos ANY /{proxy+} metode dengan izin baca/tulis. Dalam kasus apa pun, pada waktu berjalan, pelanggan atau karyawan harus memilih produk tertentu dari jenis tertentu di departemen yang dipilih, kategori produk tertentu di departemen yang dipilih, atau departemen tertentu.

Untuk informasi selengkapnya tentang menyiapkan integrasi proxy API Gateway, lihatSiapkan integrasi proxy dengan sumber daya proxy.

Integrasi proxy mengharuskan klien memiliki pengetahuan yang lebih rinci tentang persyaratan backend. Oleh karena itu, untuk memastikan kinerja aplikasi dan pengalaman pengguna yang optimal, pengembang backend harus berkomunikasi dengan jelas kepada pengembang klien persyaratan backend, dan memberikan mekanisme umpan balik kesalahan yang kuat ketika persyaratan tidak terpenuhi.

Support untuk header multi-nilai dan parameter string kueri

APIGateway mendukung beberapa header dan parameter string kueri yang memiliki nama yang sama. Header multi-nilai serta header dan parameter nilai tunggal dapat digabungkan dalam permintaan dan tanggapan yang sama. Untuk informasi selengkapnya, lihat Format input fungsi Lambda untuk integrasi proxy dan Format keluaran fungsi Lambda untuk integrasi proxy.

Format input fungsi Lambda untuk integrasi proxy

Dalam integrasi proxy Lambda, API Gateway memetakan seluruh permintaan klien ke event parameter input fungsi Lambda backend. Contoh berikut menunjukkan struktur peristiwa yang dikirim API Gateway ke integrasi proxy Lambda.

{
  "resource": "/my/path",
  "path": "/my/path",
  "httpMethod": "GET",
  "headers": {
    "header1": "value1",
    "header2": "value1,value2"
  },
  "multiValueHeaders": {
    "header1": [
      "value1"
    ],
    "header2": [
      "value1",
      "value2"
    ]
  },
  "queryStringParameters": {
    "parameter1": "value1,value2",
    "parameter2": "value"
  },
  "multiValueQueryStringParameters": {
    "parameter1": [
      "value1",
      "value2"
    ],
    "parameter2": [
      "value"
    ]
  },
  "requestContext": {
    "accountId": "123456789012",
    "apiId": "id",
    "authorizer": {
      "claims": null,
      "scopes": null
    },
    "domainName": "id.execute-api.us-east-1.amazonaws.com",
    "domainPrefix": "id",
    "extendedRequestId": "request-id",
    "httpMethod": "GET",
    "identity": {
      "accessKey": null,
      "accountId": null,
      "caller": null,
      "cognitoAuthenticationProvider": null,
      "cognitoAuthenticationType": null,
      "cognitoIdentityId": null,
      "cognitoIdentityPoolId": null,
      "principalOrgId": null,
      "sourceIp": "IP",
      "user": null,
      "userAgent": "user-agent",
      "userArn": null,
      "clientCert": {
        "clientCertPem": "CERT_CONTENT",
        "subjectDN": "www.example.com",
        "issuerDN": "Example issuer",
        "serialNumber": "a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1:a1",
        "validity": {
          "notBefore": "May 28 12:30:02 2019 GMT",
          "notAfter": "Aug  5 09:36:04 2021 GMT"
        }
      }
    },
    "path": "/my/path",
    "protocol": "HTTP/1.1",
    "requestId": "id=",
    "requestTime": "04/Mar/2020:19:15:17 +0000",
    "requestTimeEpoch": 1583349317135,
    "resourceId": null,
    "resourcePath": "/my/path",
    "stage": "$default"
  },
  "pathParameters": null,
  "stageVariables": null,
  "body": "Hello from Lambda!",
  "isBase64Encoded": false
}

Dalam input ke fungsi Lambda backend, requestContext objek adalah peta pasangan kunci-nilai. Di setiap pasangan, kuncinya adalah nama properti variabel $context, dan nilainya adalah nilai properti itu. APIGateway mungkin menambahkan kunci baru ke peta.

Bergantung pada fitur yang diaktifkan, requestContext peta dapat bervariasi dari satu API keAPI. Misalnya, dalam contoh sebelumnya, tidak ada jenis otorisasi yang ditentukan, jadi tidak ada $context.authorizer.* atau $context.identity.* properti yang ada. Ketika jenis otorisasi ditentukan, ini menyebabkan API Gateway meneruskan informasi pengguna resmi ke titik akhir integrasi dalam requestContext.identity objek sebagai berikut:

Format keluaran fungsi Lambda untuk integrasi proxy

Dalam integrasi proxy Lambda, API Gateway memerlukan fungsi Lambda backend untuk mengembalikan output sesuai dengan format berikut: JSON

{
    "isBase64Encoded": true|false,
    "statusCode": httpStatusCode,
    "headers": { "headerName": "headerValue", ... },
    "multiValueHeaders": { "headerName": ["headerValue", "headerValue2", ...], ... },
    "body": "..."
}

Dalam output:

CORSUntuk mengaktifkan integrasi proxy Lambda, Anda harus menambahkan Access-Control-Allow-Origin:domain-name ke output. headers domain-namebisa * untuk nama domain apa pun. Output body disusun ke frontend sebagai payload respons metode. Jika body adalah gumpalan biner, Anda dapat menyandikannya sebagai string yang dikodekan Base64 dengan menyetel true dan isBase64Encoded mengonfigurasi */* sebagai Tipe Media Biner. Jika tidak, Anda dapat mengaturnya ke false atau membiarkannya tidak ditentukan.

Jika output fungsi dari format yang berbeda, API Gateway mengembalikan respon 502 Bad Gateway kesalahan.

Untuk mengembalikan respons dalam fungsi Lambda di Node.js, Anda dapat menggunakan perintah seperti berikut:

Dalam async fungsi Lambda di Node.js, sintaks yang setara adalah: