

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

# Siapkan metode menggunakan konsol API Gateway
<a name="how-to-set-up-method-using-console"></a>

Saat membuat metode menggunakan konsol REST API, 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.

**Topics**
+ [Mengedit permintaan metode API Gateway di konsol API Gateway](#how-to-method-settings-callers-console)
+ [Menyiapkan respons metode API Gateway menggunakan konsol API Gateway](#how-to-method-response-settings-console)

## Mengedit permintaan metode API Gateway di konsol API Gateway
<a name="how-to-method-settings-callers-console"></a>

 Instruksi ini mengasumsikan Anda telah membuat permintaan metode Anda. Untuk informasi selengkapnya tentang cara membuat metode, lihat[Menyiapkan permintaan integrasi API menggunakan konsol API Gateway](how-to-method-settings-console.md).

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

1. Di bagian **Pengaturan permintaan metode**, pilih **Edit**.

1. 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.

   1. 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: 

------
#### [ JSON ]

****  

      ```
      {
        "Version":"2012-10-17",		 	 	 
        "Statement": [
          {
            "Effect": "Allow",
            "Action": [
              "execute-api:Invoke"
            ],
            "Resource": [
              "arn:aws:execute-api:us-east-1:111111111111:aaabbb/*/GET/"
            ]
          }
        ]
      }
      ```

------

      Dalam kebijakan akses ini, `arn:aws:execute-api:us-east-1:111111111111:aaabbb/*/GET/` 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](permissions.md) 

      Untuk membuat peran IAM, Anda dapat menyesuaikan instruksi dalam tutorial berikut,[Buat fungsi Lambda untuk integrasi non-proxy Lambda](getting-started-lambda-non-proxy-integration.md#getting-started-new-lambda). 

   1.  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](apigateway-use-lambda-authorizer.md) 

   1.  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 APIs menggunakan kumpulan pengguna Amazon Cognito sebagai otorisasi](apigateway-integrate-with-cognito.md) 

1.  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, lihat[Minta validasi untuk REST APIs di API Gateway](api-gateway-method-request-validation.md). 

1. Pilih **kunci API yang diperlukan** untuk meminta kunci API. Saat diaktifkan, kunci API digunakan dalam [rencana penggunaan](api-gateway-api-usage-plans.md) untuk membatasi lalu lintas klien. 

1. (Opsional) Untuk menetapkan nama operasi di Java SDK API ini, yang dihasilkan oleh API Gateway, untuk **nama Operasi**, masukkan nama. Misalnya, untuk permintaan metode`GET /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 (`Pets`dan`PetId`). Jika Anda menetapkan nama operasi sebagai`getPetById`, nama operasi SDK menjadi`GetPetById`.

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

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

   1. Untuk **Nama**, masukkan nama parameter string kueri.

   1. Pilih **Diperlukan** jika parameter string kueri yang baru dibuat akan digunakan untuk validasi permintaan. Untuk informasi selengkapnya tentang validasi permintaan, lihat[Minta validasi untuk REST APIs di API Gateway](api-gateway-method-request-validation.md).

   1. Pilih **Caching** jika parameter string kueri yang baru dibuat akan digunakan sebagai bagian dari kunci caching. Untuk informasi lebih lanjut tentang caching, lihat[Gunakan metode atau parameter integrasi sebagai kunci cache untuk mengindeks respons yang di-cache](api-gateway-caching.md#enable-api-gateway-cache-keys).

   Untuk menghapus parameter string kueri, pilih **Hapus**. 

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

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

   1. Untuk **Nama**, masukkan nama header.

   1. Pilih **Diperlukan** jika header yang baru dibuat akan digunakan untuk validasi permintaan. Untuk informasi selengkapnya tentang validasi permintaan, lihat[Minta validasi untuk REST APIs di API Gateway](api-gateway-method-request-validation.md).

   1. Pilih **Caching** jika header yang baru dibuat akan digunakan sebagai bagian dari kunci caching. Untuk informasi lebih lanjut tentang caching, lihat[Gunakan metode atau parameter integrasi sebagai kunci cache untuk mengindeks respons yang di-cache](api-gateway-caching.md#enable-api-gateway-cache-keys).

   Untuk menghapus header, pilih **Hapus**. 

1.  Untuk mendeklarasikan format payload permintaan metode dengan,, atau kata kerja `PATCH` HTTP `POST``PUT`, pilih **Request body**, dan lakukan hal berikut: 

   1. Pilih **Tambah model**.

   1. Untuk **Content-type**, masukkan tipe MIME (misalnya,). `application/json`

   1. 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](https://docs.aws.amazon.com/apigateway/latest/api/API_Model.html) API. Untuk informasi selengkapnya tentang membuat model, lihat[Model data untuk REST APIs](models-mappings-models.md). 
**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 \$1, Objective-C, dan Swift. Ini hanya diperlukan jika validasi permintaan diaktifkan terhadap muatan. 

1. Pilih **Simpan**.

## Menyiapkan respons metode API Gateway menggunakan konsol API Gateway
<a name="how-to-method-response-settings-console"></a>

 Metode API dapat memiliki satu atau lebih tanggapan. Setiap respons diindeks oleh kode status HTTP-nya. 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 metode API, ikuti petunjuk berikut.

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

1. Di bagian **Pengaturan respons metode**, pilih **Buat respons**.

1. Untuk **kode status HTTP**, masukkan kode status HTTP seperti`200`,`400`, atau`500`.

    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. 

1. Pilih **Tambahkan header**.

1.  Untuk **nama Header**, masukkan nama.

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

1.  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**.

1. Pilih **Simpan**.

Untuk mengubah respons yang ada, navigasikan ke respons metode Anda, lalu pilih **Edit**. Untuk mengubah **kode status HTTP**, 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. Selain itu, model payload respons metode penting jika Anda membuat SDK yang diketik kuat untuk API Anda.