Siapkan metode menggunakan konsol API Gateway

Saat Anda membuat metode menggunakan REST API konsol, Anda mengonfigurasi permintaan integrasi dan permintaan metode. Secara default, API Gateway membuat respons 200 metode untuk metode Anda.

Petunjuk berikut menunjukkan cara mengedit pengaturan permintaan metode dan cara membuat respons metode tambahan untuk metode Anda.

Mengedit permintaan metode API Gateway di konsol API Gateway

Instruksi ini mengasumsikan Anda telah membuat permintaan metode Anda. Untuk informasi selengkapnya tentang cara membuat metode, lihatMenyiapkan permintaan integrasi API menggunakan konsol API Gateway.

1. Di panel Resources, pilih metode Anda, lalu pilih tab Permintaan metode.

2. Di bagian Pengaturan permintaan metode, pilih Edit.

3. Untuk Otorisasi, pilih otorisasi yang tersedia.

   1. Untuk mengaktifkan akses terbuka ke metode untuk pengguna mana pun, pilih Tidak Ada. Langkah ini dapat dilewati jika pengaturan default belum diubah.

   2. Untuk menggunakan IAM izin untuk mengontrol akses klien ke metode, pilihAWS_IAM. Dengan pilihan ini, hanya pengguna IAM peran dengan IAM kebijakan terlampir yang benar yang diizinkan untuk memanggil metode ini.

      Untuk membuat IAM peran, tentukan kebijakan akses dengan format seperti berikut:

      {
        "Version": "2012-10-17",
        "Statement": [
          {
            "Effect": "Allow",
            "Action": [
              "execute-api:Invoke"
            ],
            "Resource": [
              "resource-statement"
            ]
          }
        ]
      }  

      Dalam kebijakan akses ini, resource-statement adalah ARN metode Anda. Anda dapat menemukan ARN metode Anda dengan memilih metode pada halaman Sumber Daya. Untuk informasi selengkapnya tentang menyetel IAM izin, lihatKontrol akses ke a REST API dengan IAM izin.

      Untuk membuat IAM peran, Anda dapat menyesuaikan instruksi dalam tutorial berikut,Buat fungsi Lambda untuk integrasi non-proxy Lambda.

   3. Untuk menggunakan otorisasi Lambda, pilih token atau otorisasi permintaan. Buat otorisasi Lambda agar pilihan ini ditampilkan di menu tarik-turun. Untuk informasi tentang cara membuat otorisasi Lambda, lihat. Gunakan otorisasi API Gateway Lambda

   4. Untuk menggunakan kumpulan pengguna Amazon Cognito, pilih kumpulan pengguna yang tersedia di bawah otorisasi kumpulan pengguna Cognito. Buat kumpulan pengguna di Amazon Cognito dan otorisasi kumpulan pengguna Amazon Cognito di Gateway agar pilihan ini ditampilkan API di menu tarik-turun. Untuk informasi tentang cara membuat otorisasi kumpulan pengguna Amazon Cognito, lihat. Kontrol akses ke REST API menggunakan kumpulan pengguna Amazon Cognito sebagai otorisasi

4. Untuk menentukan validasi permintaan, pilih nilai dari menu tarik-turun Permintaan Validator. Untuk menonaktifkan validasi permintaan, pilih Tidak Ada. Untuk informasi selengkapnya tentang setiap opsi, lihatMinta validasi untuk REST APIs di API Gateway.

5. Pilih APIkunci yang diperlukan untuk meminta API kunci. Saat diaktifkan, API kunci digunakan dalam rencana penggunaan untuk membatasi lalu lintas klien.

6. (Opsional) Untuk menetapkan nama operasi di Java iniAPI, SDK yang dihasilkan oleh API Gateway, untuk nama Operasi, masukkan nama. Misalnya, untuk permintaan metodeGET /pets/{petId}, nama SDK operasi Java yang sesuai adalah, secara default,GetPetsPetId. Nama ini dibangun dari HTTP kata kerja metode (GET) dan nama variabel jalur sumber daya (PetsdanPetId). Jika Anda menetapkan nama operasi sebagaigetPetById, nama SDK operasi menjadiGetPetById.

7. Untuk menambahkan parameter string kueri ke metode, lakukan hal berikut:

   1. Pilih parameter string URL kueri, lalu pilih Tambahkan string kueri.

   2. Untuk Nama, masukkan nama parameter string kueri.

   3. Pilih Diperlukan jika parameter string kueri yang baru dibuat akan digunakan untuk validasi permintaan. Untuk informasi selengkapnya tentang validasi permintaan, lihatMinta validasi untuk REST APIs di API Gateway.

   4. Pilih Caching jika parameter string kueri yang baru dibuat akan digunakan sebagai bagian dari kunci caching. Untuk informasi lebih lanjut tentang caching, lihatGunakan metode atau parameter integrasi sebagai kunci cache untuk mengindeks respons yang di-cache.

   Untuk menghapus parameter string kueri, pilih Hapus.

8. Untuk menambahkan parameter header ke metode, lakukan hal berikut:

   1. Pilih header HTTP permintaan, lalu pilih Tambah header.

   2. Untuk Nama, masukkan nama header.

   3. Pilih Diperlukan jika header yang baru dibuat akan digunakan untuk validasi permintaan. Untuk informasi selengkapnya tentang validasi permintaan, lihatMinta validasi untuk REST APIs di API Gateway.

   4. Pilih Caching jika header yang baru dibuat akan digunakan sebagai bagian dari kunci caching. Untuk informasi lebih lanjut tentang caching, lihatGunakan metode atau parameter integrasi sebagai kunci cache untuk mengindeks respons yang di-cache.

   Untuk menghapus header, pilih Hapus.

9. Untuk mendeklarasikan format payload permintaan metode dengan,, atau PATCH HTTP kata kerja POSTPUT, pilih Request body, dan lakukan hal berikut:

   1. Pilih Tambah model.

   2. Untuk Content-type, masukkan MIME -type (misalnya,). application/json

   3. Untuk Model, pilih model dari menu tarik-turun. Model yang tersedia saat ini untuk API menyertakan default Empty dan Error model serta model apa pun yang telah Anda buat dan tambahkan ke koleksi ModelAPI. Untuk informasi selengkapnya tentang membuat model, lihatModel data untuk REST APIs.

      catatan

      Model ini berguna untuk memberi tahu klien tentang format data yang diharapkan dari muatan. Sangat membantu untuk menghasilkan template pemetaan kerangka. Penting untuk menghasilkan bahasa yang diketik SDK dengan kuat seperti Java, API C #, Objective-C, dan Swift. Ini hanya diperlukan jika validasi permintaan diaktifkan terhadap muatan.

10. Pilih Simpan.

Menyiapkan respons metode API Gateway menggunakan konsol API Gateway

Suatu API metode dapat memiliki satu atau lebih tanggapan. Setiap respons diindeks oleh kode HTTP statusnya. Secara default, konsol API Gateway menambahkan 200 respons ke respons metode. Anda dapat memodifikasinya, misalnya, agar metode dikembalikan 201 sebagai gantinya. Anda dapat menambahkan tanggapan lain, misalnya, untuk penolakan akses dan 409 500 untuk variabel tahap yang tidak diinisialisasi yang digunakan.

Untuk menggunakan konsol API Gateway untuk memodifikasi, menghapus, atau menambahkan respons ke API metode, ikuti petunjuk ini.

1. Di panel Resources, pilih metode Anda, lalu pilih tab Respons metode. Anda mungkin perlu memilih tombol panah kanan untuk menampilkan tab.

2. Di bagian Pengaturan respons metode, pilih Buat respons.

3. Untuk kode HTTP status, masukkan kode HTTP status seperti200,400, atau500.

   Ketika respons yang dikembalikan ke backend tidak memiliki respons metode yang sesuai yang ditentukan, API Gateway gagal mengembalikan respons ke klien. Sebaliknya, ia mengembalikan respons 500 Internal server error kesalahan.

4. Pilih Tambahkan header.

5. Untuk nama Header, masukkan nama.

   Untuk mengembalikan header dari backend ke klien, tambahkan header dalam respons metode.

6. Pilih Tambahkan model untuk menentukan format badan respons metode.

   Masukkan jenis media payload respons untuk jenis Konten dan pilih model dari menu tarik-turun Model.

7. Pilih Simpan.

Untuk mengubah respons yang ada, navigasikan ke respons metode Anda, lalu pilih Edit. Untuk mengubah kode HTTP status, pilih Hapus dan buat respons metode baru.

Untuk setiap respons yang dikembalikan dari backend, Anda harus memiliki respons yang kompatibel yang dikonfigurasi sebagai respons metode. Namun, header respons metode konfigurasi dan model payload bersifat opsional kecuali Anda memetakan hasil dari backend ke respons metode sebelum kembali ke klien. Juga, model payload respons metode penting jika Anda membuat tipe kuat SDK untuk Anda. API