Siapkan metode menggunakan konsol API Gateway

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

Di bagian Pengaturan permintaan metode, pilih Edit.

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 izin IAM untuk mengontrol akses klien ke metode, pilih. AWS_IAM Dengan pilihan ini, hanya pengguna peran IAM dengan kebijakan IAM yang benar dilampirkan yang diizinkan untuk memanggil metode ini.

   Untuk membuat peran IAM, 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 izin IAM, lihat. Kontrol akses ke REST API dengan izin IAM

   Untuk membuat peran IAM, 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 API Gateway agar pilihan ini ditampilkan 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

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.

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

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

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

1. Pilih parameter string Kueri URL, 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.

Untuk menambahkan parameter header ke metode, lakukan hal berikut:

1. Pilih header permintaan HTTP, 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.

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

1. Pilih Tambah model.

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

3. Untuk Model, pilih model dari menu tarik-turun. Model yang tersedia saat ini untuk API mencakup default Empty dan Error model serta model apa pun yang telah Anda buat dan tambahkan ke koleksi Model API. 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 SDK API yang diketik dengan kuat dalam bahasa seperti Java, C #, Objective-C, dan Swift. Ini hanya diperlukan jika validasi permintaan diaktifkan terhadap muatan.

Pilih Simpan.

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

Di bagian Pengaturan respons metode, pilih Buat respons.

Untuk kode status HTTP, masukkan kode status HTTP 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.

Pilih Tambahkan header.

Untuk nama Header, masukkan nama.

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

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.

Pilih Simpan.