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

Tutorial: Buat REST API dengan integrasi non-proxy Lambda

Dalam panduan ini, kami menggunakan konsol API Gateway untuk membangun sebuah API yang memungkinkan klien memanggil fungsi Lambda melalui integrasi non-proxy Lambda (juga dikenal sebagai integrasi khusus). Untuk informasi selengkapnya tentang AWS Lambda dan fungsi Lambda, lihat Panduan AWS Lambda Pengembang.

Untuk memfasilitasi pembelajaran, kami memilih fungsi Lambda sederhana dengan API pengaturan minimal untuk memandu Anda melalui langkah-langkah membangun API Gateway API dengan integrasi khusus Lambda. Bila perlu, kami menjelaskan beberapa logika. Untuk contoh lebih rinci tentang integrasi kustom Lambda, lihat. Tutorial: Buat kalkulator REST API dengan dua integrasi AWS layanan dan satu integrasi non-proxy Lambda

Sebelum membuatAPI, atur backend Lambda dengan membuat fungsi Lambda di, dijelaskan selanjutnya. AWS Lambda

Buat fungsi Lambda untuk integrasi non-proxy Lambda

Pada langkah ini, Anda membuat “Halo, Dunia!” -seperti fungsi Lambda untuk integrasi kustom Lambda. Sepanjang panduan ini, fungsi ini disebut. GetStartedLambdaIntegration

Implementasi fungsi GetStartedLambdaIntegration Lambda ini adalah sebagai berikut:

Node.js

'use strict';
var days = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'];            
var times = ['morning', 'afternoon', 'evening', 'night', 'day'];

console.log('Loading function');

export const handler = function(event, context, callback) {
  // Parse the input for the name, city, time and day property values
  let name = event.name === undefined ? 'you' : event.name;
  let city = event.city === undefined ? 'World' : event.city;
  let time = times.indexOf(event.time)<0 ? 'day' : event.time;
  let day = days.indexOf(event.day)<0 ? null : event.day;

  // Generate a greeting
  let greeting = 'Good ' + time + ', ' + name + ' of ' + city + '. ';
  if (day) greeting += 'Happy ' + day + '!';
  
  // Log the greeting to CloudWatch
  console.log('Hello: ', greeting);
  
  // Return a greeting to the caller
  callback(null, {
      "greeting": greeting
  }); 
};

Python

import json

days = {
    'Sunday',
    'Monday',
    'Tuesday',
    'Wednesday',
    'Thursday',
    'Friday',
    'Saturday'}
times = {'morning', 'afternoon', 'evening', 'night', 'day'}


def lambda_handler(event, context):
    print(event)
    # parse the input for the name, city, time, and day property values
    try:
        if event['name']:
            name = event['name']
    except KeyError:
        name = 'you'
    try:
        if event['city']:
            city = event['city']
    except KeyError:
        city = 'World'
    try:
        if event['time'] in times:
            time = event['time']
        else:
            time = 'day'
    except KeyError:
        time = 'day'
    try:
        if event['day'] in days:
            day = event['day']
        else:
            day = ''
    except KeyError:
        day = ''
    # Generate a greeting
    greeting = 'Good ' + time + ', ' + name + ' of ' + \
        city + '.' + ['', ' Happy ' + day + '!'][day != '']
    # Log the greeting to CloudWatch
    print(greeting)

    # Return a greeting to the caller
    return {"greeting": greeting}

Untuk integrasi kustom Lambda, API Gateway meneruskan input ke fungsi Lambda dari klien sebagai badan permintaan integrasi. eventObjek dari fungsi handler Lambda adalah input.

Fungsi Lambda kami sederhana. Ini mem-parsing event objek input untukname,, citytime, dan day properti. Kemudian mengembalikan salam, sebagai JSON objek{"message":greeting}, ke penelepon. Pesannya ada dalam "Good [morning|afternoon|day], [name|you] in [city|World]. Happy day!" pola. Diasumsikan bahwa input ke fungsi Lambda adalah dari objek berikut: JSON

{
  "city": "...",
  "time": "...",
  "day": "...",
  "name" : "..."
}

Lihat informasi selengkapnya di Panduan Developer AWS Lambda.

Selain itu, fungsi mencatat eksekusinya ke Amazon CloudWatch dengan meneleponconsole.log(...). Ini berguna untuk melacak panggilan saat men-debug fungsi. Untuk mengizinkan GetStartedLambdaIntegration fungsi mencatat panggilan, tetapkan IAM peran dengan kebijakan yang sesuai untuk fungsi Lambda untuk membuat CloudWatch aliran dan menambahkan entri log ke aliran. Konsol Lambda memandu Anda untuk membuat IAM peran dan kebijakan yang diperlukan.

Jika Anda mengatur API tanpa menggunakan konsol API Gateway, seperti saat mengimpor API dari API file Terbuka, Anda harus secara eksplisit membuat, jika perlu, dan menyiapkan peran dan kebijakan pemanggilan API agar Gateway memanggil fungsi Lambda. Untuk informasi selengkapnya tentang cara mengatur peran pemanggilan dan eksekusi Lambda untuk Gateway, lihat. API API Kontrol akses ke a REST API dengan IAM izin

Dibandingkan denganGetStartedLambdaProxyIntegration, fungsi Lambda untuk integrasi proxy Lambda, fungsi Lambda untuk integrasi kustom GetStartedLambdaIntegration Lambda hanya mengambil masukan dari badan permintaan integrasi Gateway. API API Fungsi ini dapat mengembalikan output dari JSON objek apa pun, string, angka, Boolean, atau bahkan gumpalan biner. Fungsi Lambda untuk integrasi proxy Lambda, sebaliknya, dapat mengambil input dari data permintaan apa pun, tetapi harus mengembalikan output dari objek tertentu. JSON GetStartedLambdaIntegrationFungsi untuk integrasi kustom Lambda dapat memiliki parameter API permintaan sebagai input, asalkan API Gateway memetakan parameter API permintaan yang diperlukan ke badan permintaan integrasi sebelum meneruskan permintaan klien ke backend. Agar hal ini terjadi, API pengembang harus membuat template pemetaan dan mengkonfigurasinya pada API metode saat membuat. API

Sekarang, buat fungsi GetStartedLambdaIntegration Lambda.

Sebagai latihan sampingan, Anda dapat menggunakan IAM konsol untuk melihat IAM role (GetStartedLambdaIntegrationRole) yang dibuat sebagai bagian dari pembuatan fungsi Lambda. Terlampir pada IAM peran ini adalah dua kebijakan inline. Satu menetapkan izin paling dasar untuk eksekusi Lambda. Ini memungkinkan memanggil CloudWatch sumber daya apa pun dari akun Anda di wilayah tempat fungsi Lambda dibuat. CloudWatch CreateLogGroup Kebijakan ini juga memungkinkan pembuatan CloudWatch stream dan peristiwa logging untuk fungsi GetStartedLambdaIntegration Lambda.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "logs:CreateLogGroup",
            "Resource": "arn:aws:logs:region:account-id:*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "logs:CreateLogStream",
                "logs:PutLogEvents"
            ],
            "Resource": [
                "arn:aws:logs:region:account-id:log-group:/aws/lambda/GetStartedLambdaIntegration:*"
            ]
        }
    ]
}

Dokumen kebijakan lainnya berlaku untuk memanggil AWS layanan lain yang tidak digunakan dalam contoh ini. Anda dapat melewatkannya untuk saat ini.

Terkait dengan IAM peran adalah entitas tepercaya, yaitulambda.amazonaws.com. Inilah hubungan kepercayaannya:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "lambda.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

Kombinasi hubungan kepercayaan ini dan kebijakan sebaris memungkinkan fungsi Lambda memanggil fungsi untuk mencatat peristiwa ke console.log() Log. CloudWatch

Buat integrasi API non-proxy dengan Lambda

Dengan fungsi Lambda (GetStartedLambdaIntegration) dibuat dan diuji, Anda siap untuk mengekspos fungsi melalui Gateway. API API Untuk tujuan ilustrasi, kami mengekspos fungsi Lambda dengan metode generik. HTTP Kami menggunakan badan permintaan, variabel URL jalur, string kueri, dan header untuk menerima data input yang diperlukan dari klien. Kami mengaktifkan validator permintaan API Gateway API untuk memastikan bahwa semua data yang diperlukan didefinisikan dan ditentukan dengan benar. Kami mengonfigurasi template pemetaan untuk API Gateway untuk mengubah data permintaan yang disediakan klien ke dalam format yang valid seperti yang dipersyaratkan oleh fungsi Lambda backend.

Setelah membuatAPI, Anda membuat sumber daya/{city}. Ini adalah contoh sumber daya dengan variabel jalur yang mengambil masukan dari klien. Kemudian, Anda memetakan variabel jalur ini ke input fungsi Lambda menggunakan template pemetaan.

Setelah membuat sumber daya/{city} Anda, Anda membuat ANY metode. ANYHTTPKata kerja adalah placeholder untuk HTTP metode yang valid yang dikirimkan klien pada waktu berjalan. Contoh ini menunjukkan bahwa ANY metode dapat digunakan untuk integrasi kustom Lambda serta untuk integrasi proxy Lambda.

Setelah mengaktifkan validator permintaan, Anda mengonfigurasi permintaan integrasi untuk ANY metode dengan menambahkan templat pemetaan tubuh untuk mengubah permintaan yang masuk menjadi JSON payload, seperti yang dipersyaratkan oleh fungsi Lambda backend.

Uji memanggil metode API

Konsol API Gateway menyediakan fasilitas pengujian bagi Anda untuk menguji pemanggilan API sebelum digunakan. Anda menggunakan fitur Uji konsol untuk menguji API dengan mengirimkan permintaan berikut:

POST /Seattle?time=morning
day:Wednesday

{
    "callerName": "John"
}

Dalam permintaan pengujian ini, Anda akan mengatur ANY kePOST, mengatur {city} keSeattle, menetapkan Wednesday sebagai nilai day header, dan menetapkan "John" sebagai nilaicallerName.

Verifikasi bahwa muatan respons yang dikembalikan adalah sebagai berikut:

{
  "greeting": "Good morning, John of Seattle. Happy Wednesday!"
}

Anda juga dapat melihat log untuk memeriksa bagaimana API Gateway memproses permintaan dan respons.

Execution log for request test-request
Thu Aug 31 01:07:25 UTC 2017 : Starting execution for request: test-invoke-request
Thu Aug 31 01:07:25 UTC 2017 : HTTP Method: POST, Resource Path: /Seattle
Thu Aug 31 01:07:25 UTC 2017 : Method request path: {city=Seattle}
Thu Aug 31 01:07:25 UTC 2017 : Method request query string: {time=morning}
Thu Aug 31 01:07:25 UTC 2017 : Method request headers: {day=Wednesday}
Thu Aug 31 01:07:25 UTC 2017 : Method request body before transformations: { "callerName": "John" }
Thu Aug 31 01:07:25 UTC 2017 : Request validation succeeded for content type application/json
Thu Aug 31 01:07:25 UTC 2017 : Endpoint request URI: https://lambda.us-west-2.amazonaws.com/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:GetStartedLambdaIntegration/invocations
Thu Aug 31 01:07:25 UTC 2017 : Endpoint request headers: {x-amzn-lambda-integration-tag=test-request, Authorization=****************************************************************************************************************************************************************************************************************************************************************************************************************************************338c72, X-Amz-Date=20170831T010725Z, x-amzn-apigateway-api-id=beags1mnid, X-Amz-Source-Arn=arn:aws:execute-api:us-west-2:123456789012:beags1mnid/null/POST/{city}, Accept=application/json, User-Agent=AmazonAPIGateway_beags1mnid, X-Amz-Security-Token=FQoDYXdzELL//////////wEaDMHGzEdEOT/VvGhabiK3AzgKrJw+3zLqJZG4PhOq12K6W21+QotY2rrZyOzqhLoiuRg3CAYNQ2eqgL5D54+63ey9bIdtwHGoyBdq8ecWxJK/YUnT2Rau0L9HCG5p7FC05h3IvwlFfvcidQNXeYvsKJTLXI05/yEnY3ttIAnpNYLOezD9Es8rBfyruHfJfOqextKlsC8DymCcqlGkig8qLKcZ0hWJWVwiPJiFgL7laabXs++ZhCa4hdZo4iqlG729DE4gaV1mJVdoAagIUwLMo+y4NxFDu0r7I0/EO5nYcCrppGVVBYiGk7H4T6sXuhTkbNNqVmXtV3ch5bOlh7 [TRUNCATED]
Thu Aug 31 01:07:25 UTC 2017 : Endpoint request body after transformations: {
  "city": "Seattle",
  "time": "morning",
  "day": "Wednesday",
  "name" : "John"
}
Thu Aug 31 01:07:25 UTC 2017 : Sending request to https://lambda.us-west-2.amazonaws.com/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:GetStartedLambdaIntegration/invocations
Thu Aug 31 01:07:25 UTC 2017 : Received response. Integration latency: 328 ms
Thu Aug 31 01:07:25 UTC 2017 : Endpoint response body before transformations: {"greeting":"Good morning, John of Seattle. Happy Wednesday!"}
Thu Aug 31 01:07:25 UTC 2017 : Endpoint response headers: {x-amzn-Remapped-Content-Length=0, x-amzn-RequestId=c0475a28-8de8-11e7-8d3f-4183da788f0f, Connection=keep-alive, Content-Length=62, Date=Thu, 31 Aug 2017 01:07:25 GMT, X-Amzn-Trace-Id=root=1-59a7614d-373151b01b0713127e646635;sampled=0, Content-Type=application/json}
Thu Aug 31 01:07:25 UTC 2017 : Method response body after transformations: {"greeting":"Good morning, John of Seattle. Happy Wednesday!"}
Thu Aug 31 01:07:25 UTC 2017 : Method response headers: {X-Amzn-Trace-Id=sampled=0;root=1-59a7614d-373151b01b0713127e646635, Content-Type=application/json}
Thu Aug 31 01:07:25 UTC 2017 : Successfully completed execution
Thu Aug 31 01:07:25 UTC 2017 : Method completed with status: 200

Log menampilkan permintaan masuk sebelum pemetaan dan permintaan integrasi setelah pemetaan. Ketika pengujian gagal, log berguna untuk mengevaluasi apakah input asli benar atau template pemetaan berfungsi dengan benar.

Menyebarkan API

Doa tes adalah simulasi dan memiliki keterbatasan. Misalnya, ia melewati mekanisme otorisasi apa pun yang diberlakukan pada. API Untuk menguji API eksekusi secara real time, Anda harus menerapkan yang API pertama. Untuk menerapkanAPI, Anda membuat panggung untuk membuat snapshot API pada saat itu. Nama panggung juga mendefinisikan jalur dasar setelah API nama host default. Sumber API daya root ditambahkan setelah nama panggung. Saat Anda memodifikasiAPI, Anda harus menerapkannya kembali ke tahap baru atau yang sudah ada sebelum perubahan diterapkan.

Di bawah Detail tahap, pilih ikon salin untuk menyalin API panggilan Anda. URL Pola umum API basis URL adalahhttps://api-id.region.amazonaws.com/stageName. Misalnya, basis API (beags1mnid) URL yang dibuat di us-west-2 wilayah dan dikerahkan ke test panggung adalahhttps://beags1mnid.execute-api.us-west-2.amazonaws.com/test.

Uji API dalam tahap penerapan

Ada beberapa cara Anda dapat menguji deployedAPI. Untuk GET permintaan yang hanya menggunakan variabel URL jalur atau parameter string kueri, Anda dapat memasukkan API sumber daya URL di browser. Untuk metode lain, Anda harus menggunakan utilitas REST API pengujian yang lebih canggih, seperti POSTMANatau c URL.

Bersihkan

Jika Anda tidak lagi membutuhkan fungsi Lambda yang Anda buat untuk panduan ini, Anda dapat menghapusnya sekarang. Anda juga dapat menghapus sumber daya yang menyertainyaIAM.