Menyiapkan permintaan integrasi API menggunakan konsol API Gateway - APIGerbang Amazon
Siapkan integrasi LambdaSiapkan integrasi HTTPSiapkan integrasi AWS layananSiapkan integrasi tiruan

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

Menyiapkan permintaan integrasi API menggunakan konsol API Gateway

Penyiapan metode API mendefinisikan metode dan menjelaskan perilakunya. Untuk mengatur metode, Anda harus menentukan sumber daya, termasuk root (“/”), di mana metode diekspos, metode HTTP (,, dll.) GETPOST, Dan bagaimana itu akan diintegrasikan dengan backend yang ditargetkan. Permintaan dan respons metode menentukan kontrak dengan aplikasi panggilan, menetapkan parameter mana yang dapat diterima API dan seperti apa responsnya.

Prosedur berikut menjelaskan cara menggunakan konsol API Gateway untuk membuat permintaan integrasi.

Siapkan integrasi Lambda

Gunakan integrasi fungsi Lambda untuk mengintegrasikan API Anda dengan fungsi Lambda. Pada API level, ini adalah tipe AWS integrasi jika Anda membuat integrasi non-proxy, atau tipe AWS_PROXY integrasi jika Anda membuat integrasi proxy.

Untuk mengatur integrasi Lambda

  1. Di panel Resources, pilih Create method.

  2. Untuk jenis Metode, pilih metode HTTP.

  3. Untuk jenis Integrasi, pilih fungsi Lambda.

  4. Untuk menggunakan integrasi proxy Lambda, aktifkan integrasi proxy Lambda. Untuk mempelajari lebih lanjut tentang integrasi proxy Lambda, lihat. Memahami API integrasi proxy Gateway Lambda

  5. Untuk fungsi Lambda, masukkan nama fungsi Lambda.

    Jika Anda menggunakan fungsi Lambda di Wilayah yang berbeda dari API Anda, pilih Wilayah dari menu tarik-turun dan masukkan nama fungsi Lambda. Jika Anda menggunakan fungsi Lambda lintas akun, masukkan fungsi ARN.

  6. Untuk menggunakan nilai batas waktu default 29 detik, tetap aktifkan batas waktu default. Untuk menetapkan batas waktu kustom, pilih Batas waktu default dan masukkan nilai batas waktu antara 50 dan milidetik. 29000

  7. (Opsional) Anda dapat mengonfigurasi pengaturan permintaan metode menggunakan menu tarik-turun berikut. Pilih Pengaturan permintaan metode dan konfigurasikan permintaan metode Anda. Untuk informasi lebih lanjut, lihat langkah 3 dariMengedit permintaan metode API Gateway di konsol API Gateway.

    Anda juga dapat mengonfigurasi pengaturan permintaan metode Anda setelah Anda membuat metode Anda.

  8. Pilih metode Buat.

Siapkan integrasi HTTP

Gunakan integrasi HTTP untuk mengintegrasikan API Anda dengan titik akhir HTTP. Pada level API, ini adalah tipe HTTP integrasi.

Untuk mengatur integrasi HTTP

  1. Di panel Resources, pilih Create method.

  2. Untuk jenis Metode, pilih metode HTTP.

  3. Untuk jenis Integrasi, pilih HTTP.

  4. Untuk menggunakan integrasi proxy HTTP, aktifkan integrasi proxy HTTP. Untuk mempelajari lebih lanjut tentang integrasi proxy HTTP, lihatSiapkan integrasi proxy HTTP di API Gateway.

  5. Untuk metode HTTP, pilih jenis metode HTTP yang paling cocok dengan metode di backend HTTP.

  6. Untuk URL Endpoint, masukkan URL backend HTTP yang ingin digunakan metode ini.

  7. Untuk penanganan Konten, pilih perilaku penanganan konten.

  8. Untuk menggunakan nilai batas waktu default 29 detik, tetap aktifkan batas waktu default. Untuk menetapkan batas waktu kustom, pilih Batas waktu default dan masukkan nilai batas waktu antara 50 dan milidetik. 29000

  9. (Opsional) Anda dapat mengonfigurasi pengaturan permintaan metode menggunakan menu tarik-turun berikut. Pilih Pengaturan permintaan metode dan konfigurasikan permintaan metode Anda. Untuk informasi lebih lanjut, lihat langkah 3 dariMengedit permintaan metode API Gateway di konsol API Gateway.

    Anda juga dapat mengonfigurasi pengaturan permintaan metode Anda setelah Anda membuat metode Anda.

  10. Pilih metode Buat.

Siapkan integrasi AWS layanan

Gunakan integrasi AWS layanan untuk mengintegrasikan API Anda secara langsung dengan AWS layanan. Pada level API, ini adalah tipe AWS integrasi.

Untuk menyiapkan API Gateway API untuk melakukan salah satu hal berikut:

  • Buat fungsi Lambda baru.

  • Tetapkan izin sumber daya pada fungsi Lambda.

  • Lakukan tindakan layanan Lambda lainnya.

Anda harus memilih AWS layanan.

Untuk mengatur integrasi AWS layanan

  1. Di panel Resources, pilih Create method.

  2. Untuk jenis Metode, pilih metode HTTP.

  3. Untuk jenis Integrasi, pilih AWS layanan.

  4. Untuk AWS Wilayah, pilih AWS Wilayah yang ingin digunakan metode ini untuk memanggil tindakan.

  5. Untuk AWS layanan, pilih AWS layanan yang Anda inginkan untuk memanggil metode ini.

  6. Untuk AWS subdomain, masukkan subdomain yang digunakan oleh layanan. AWS Biasanya, Anda akan membiarkan ini kosong. Beberapa AWS layanan dapat mendukung subdomain sebagai bagian dari host. Konsultasikan dokumentasi layanan untuk ketersediaan dan, jika tersedia, detailnya.

  7. Untuk metode HTTP, pilih jenis metode HTTP yang sesuai dengan tindakan. Untuk jenis metode HTTP, lihat dokumentasi referensi API untuk AWS layanan yang Anda pilih untuk AWS layanan.

  8. Untuk tipe Tindakan, pilih Gunakan nama tindakan untuk menggunakan tindakan API atau Use path override untuk menggunakan jalur sumber daya kustom. Untuk tindakan yang tersedia dan jalur sumber daya khusus, lihat dokumentasi referensi API untuk AWS layanan yang Anda pilih untuk AWS layanan.

  9. Masukkan nama Action atau Path override.

  10. Untuk peran Eksekusi, masukkan ARN dari peran IAM yang akan digunakan metode untuk memanggil tindakan.

    Untuk membuat peran IAM, Anda dapat menyesuaikan instruksi diLangkah 1: Buat peran eksekusi proxy AWS layanan. Tentukan kebijakan akses format berikut, dengan jumlah tindakan dan pernyataan sumber daya yang diinginkan:

    {
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "action-statement"
      ],
      "Resource": [
        "resource-statement"
      ]
    },
    ...
  ]
}

    Untuk sintaks pernyataan tindakan dan sumber daya, lihat dokumentasi untuk AWS layanan yang Anda pilih untuk AWS layanan.

    Untuk hubungan kepercayaan peran IAM, tentukan hal berikut, yang memungkinkan API Gateway mengambil tindakan atas nama AWS akun Anda:

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

  11. Untuk menggunakan nilai batas waktu default 29 detik, tetap aktifkan batas waktu default. Untuk menetapkan batas waktu kustom, pilih Batas waktu default dan masukkan nilai batas waktu antara 50 dan milidetik. 29000

  12. (Opsional) Anda dapat mengonfigurasi pengaturan permintaan metode menggunakan menu tarik-turun berikut. Pilih Pengaturan permintaan metode dan konfigurasikan permintaan metode Anda. Untuk informasi lebih lanjut, lihat langkah 3 dariMengedit permintaan metode API Gateway di konsol API Gateway.

    Anda juga dapat mengonfigurasi pengaturan permintaan metode Anda setelah Anda membuat metode Anda.

  13. Pilih metode Buat.

Siapkan integrasi tiruan

Gunakan integrasi tiruan jika Anda ingin API Gateway bertindak sebagai backend Anda untuk mengembalikan respons statis. Pada level API, ini adalah tipe MOCK integrasi. Biasanya, Anda dapat menggunakan MOCK integrasi saat API Anda belum final, tetapi Anda ingin menghasilkan respons API untuk membuka blokir tim dependen untuk pengujian. Untuk OPTION metode ini, API Gateway menetapkan MOCK integrasi sebagai default untuk mengembalikan header yang mengaktifkan CORS untuk sumber daya API yang diterapkan.

Untuk mengatur integrasi tiruan

  1. Di panel Resources, pilih Create method.

  2. Untuk jenis Metode, pilih metode HTTP.

  3. Untuk tipe Integrasi, pilih Mock.

  4. (Opsional) Anda dapat mengonfigurasi pengaturan permintaan metode menggunakan menu tarik-turun berikut. Pilih Pengaturan permintaan metode dan konfigurasikan permintaan metode Anda. Untuk informasi lebih lanjut, lihat langkah 3 dariMengedit permintaan metode API Gateway di konsol API Gateway.

    Anda juga dapat mengonfigurasi pengaturan permintaan metode Anda setelah Anda membuat metode Anda.

  5. Pilih metode Buat.