Buat penerapan untuk REST API in Gateway API

Di API Gateway, REST API penyebaran diwakili oleh sumber daya Deployment. Ini mirip dengan executable dari sebuah API yang diwakili oleh sumber daya. RestApi

Agar klien dapat memanggil AndaAPI, Anda harus membuat penyebaran dan mengaitkan panggung dengannya. Sebuah panggung diwakili oleh sumber daya Panggung. Ini merupakan snapshot dariAPI, termasuk metode, integrasi, model, template pemetaan, dan otorisasi Lambda (sebelumnya dikenal sebagai otorisasi khusus). Saat memperbaruiAPI, Anda dapat menerapkan ulang API dengan mengaitkan tahap baru dengan penerapan yang ada. Kami membahas membuat panggung diSiapkan panggung untuk REST API in API Gateway.

Buat deployment

Prosedur berikut menunjukkan cara membuat penyebaran untuk file. REST API

AWS Management Console

Anda harus telah membuat REST API sebelum menerapkannya untuk pertama kalinya. Untuk informasi selengkapnya, lihat Berkembang REST APIs di API Gateway.

Konsol API Gateway memungkinkan Anda menerapkan API dengan membuat penerapan dan mengaitkannya dengan tahap baru atau yang sudah ada.

1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

2. Di panel APIsnavigasi, pilih yang ingin API Anda gunakan.

3. Di panel Resources, pilih APIDeploy.

4. Untuk Stage, pilih dari berikut ini:

   1. Untuk membuat tahap baru, pilih Tahap baru, lalu masukkan nama di Nama panggung. Secara opsional, Anda dapat memberikan deskripsi untuk penyebaran dalam deskripsi Deployment.

   2. Untuk memilih tahap yang ada, pilih nama panggung dari menu tarik-turun. Anda mungkin ingin memberikan deskripsi penerapan baru dalam deskripsi Deployment.

   3. Untuk membuat penyebaran yang tidak terkait dengan tahap, pilih Tidak ada tahap. Nanti, Anda dapat mengaitkan penerapan ini dengan sebuah panggung.

5. Pilih Deploy.

AWS CLI

Saat membuat penerapan, Anda membuat instance sumber daya Deployment. Anda dapat menggunakan konsol API Gateway, the AWS CLI, an AWS SDK, atau API Gateway REST API untuk membuat penerapan.

Untuk menggunakan CLI untuk membuat penerapan, gunakan perintah create-deployment:

 aws apigateway create-deployment --rest-api-id <rest-api-id> --region <region>

APIIni tidak dapat dipanggil sampai Anda mengaitkan penerapan ini dengan sebuah panggung. Dengan tahap yang ada, Anda dapat melakukan ini dengan memperbarui deploymentIdproperti stage dengan ID deployment (<deployment-id>) yang baru dibuat.

 aws apigateway update-stage --region <region> \
    --rest-api-id <rest-api-id> \ 
    --stage-name <stage-name> \ 
    --patch-operations op='replace',path='/deploymentId',value='<deployment-id>'

Saat menerapkan API pertama kali, Anda dapat menggabungkan pembuatan panggung dan pembuatan penerapan secara bersamaan:

 aws apigateway create-deployment --region <region> \
    --rest-api-id <rest-api-id> \
    --stage-name <stage-name>

Inilah yang dilakukan di balik layar di konsol API Gateway saat Anda menerapkan pertama kali, atau saat Anda menerapkan ulang API ke tahap baru. API

Untuk menerapkan ulangAPI, lakukan langkah yang sama. Anda dapat menggunakan kembali tahap yang sama sebanyak yang diinginkan.

Langkah selanjutnya untuk API penerapan Anda

Berikut ini adalah langkah selanjutnya untuk API penerapan Anda.

Ubah pengaturan panggung

Setelah API di-deploy, Anda dapat memodifikasi pengaturan panggung untuk mengaktifkan atau menonaktifkan API cache, logging, atau permintaan throttling. Anda juga dapat memilih sertifikat klien untuk backend untuk mengautentikasi API Gateway dan mengatur variabel tahap untuk meneruskan konteks penerapan ke integrasi saat API runtime. Untuk informasi selengkapnya, lihat Ubah pengaturan panggung

Setelah memodifikasi pengaturan tahap, Anda harus menerapkan ulang API agar perubahan diterapkan.

catatan

Jika setelan yang diperbarui, seperti mengaktifkan pencatatan, memerlukan IAM peran baru, Anda dapat menambahkan IAM peran yang diperlukan tanpa menerapkan ulang. API Namun, mungkin perlu beberapa menit sebelum IAM peran baru diterapkan. Sebelum itu terjadi, jejak API panggilan Anda tidak dicatat bahkan jika Anda telah mengaktifkan opsi logging.

Pilih kombinasi tahap penerapan yang berbeda

Karena penerapan mewakili API snapshot dan tahapan menentukan jalur ke dalam snapshot, Anda dapat memilih kombinasi tahapan penerapan yang berbeda untuk mengontrol cara pengguna memanggil ke versi yang berbeda. API Ini berguna, misalnya, ketika Anda ingin memutar kembali API status ke penerapan sebelumnya atau menggabungkan 'cabang pribadi' dari ke publik. API

Prosedur berikut menunjukkan cara melakukan ini menggunakan Stage Editor di konsol API Gateway. Hal ini diasumsikan bahwa Anda harus telah menerapkan API lebih dari sekali.

1. Jika Anda belum berada di panel Tahapan, di panel navigasi utama, pilih Tahapan.

2. Pilih tahap yang ingin Anda perbarui.

3. Pada tab Riwayat Deployment, pilih penyebaran yang ingin Anda gunakan untuk tahap.

4. Pilih Ubah penerapan aktif.

5. Konfirmasikan bahwa Anda ingin mengubah penerapan aktif dan pilih Ubah penerapan aktif di kotak dialog Make active deployment.

Teruskan data khusus penerapan ke Anda. API

Untuk penerapan, Anda dapat mengatur atau memodifikasi variabel tahap untuk meneruskan data khusus penerapan ke integrasi saat runtime. API Anda dapat melakukan ini pada tab Stage Variables di Stage Editor. Untuk informasi lebih lanjut, lihat petunjuk diGunakan variabel panggung untuk REST API di API Gateway.