Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Menerapkan REST API di Amazon API Gateway
Setelah membuat API, Anda harus menerapkannya agar dapat dipanggil oleh pengguna Anda.
Untuk menerapkan API, Anda membuat penerapan API dan mengaitkannya dengan sebuah panggung. Stage adalah referensi logis ke status siklus hidup API Anda (misalnya,,, dev prodbeta,v2). Tahapan API diidentifikasi oleh ID API dan nama panggung. Mereka disertakan dalam URL yang Anda gunakan untuk menjalankan API. Setiap tahap adalah referensi bernama untuk deployment API dan dibuat tersedia bagi aplikasi klien untuk dipanggil.
penting
Setiap kali Anda memperbarui API, Anda harus menerapkan ulang API ke tahap yang ada atau ke tahap baru. Memperbarui API mencakup memodifikasi rute, metode, integrasi, otorisasi, kebijakan sumber daya, dan hal lain selain pengaturan tahap.
Saat API Anda berkembang, Anda dapat terus menerapkannya ke tahapan yang berbeda sebagai versi API yang berbeda. Anda juga dapat menerapkan pembaruan API Anda sebagai penerapan rilis canary. Hal ini memungkinkan klien API Anda untuk mengakses, pada tahap yang sama, versi produksi melalui rilis produksi, dan versi terbaru melalui rilis canary.
Untuk memanggil API yang diterapkan, klien mengirimkan permintaan terhadap URL API. URL ditentukan oleh protokol API (HTTP (S) atau (WSS)), nama host, nama panggung, dan jalur sumber daya (untuk REST API). Nama host dan nama panggung menentukan URL dasar API.
Menggunakan nama domain default API, URL dasar REST API (misalnya) dalam tahap tertentu ({stageName}
https://{restapi-id}.execute-api.{region}.amazonaws.com/{stageName}
Untuk membuat URL dasar default API lebih ramah pengguna, Anda dapat membuat nama domain kustom (misalnya,api.example.com) untuk mengganti nama host default API. Untuk mendukung beberapa API di bawah nama domain kustom, Anda harus memetakan tahap API ke jalur dasar.
Dengan nama domain kustom {api.example.com}{basePath}
https://{api.example.com}/{basePath}
Untuk setiap tahap, Anda dapat mengoptimalkan performa API dengan menyesuaikan batas pembatasan permintaan tingkat akun default dan mengaktifkan caching API. Anda juga dapat mengaktifkan logging untuk panggilan API ke CloudTrail atau CloudWatch, dan dapat memilih sertifikat klien untuk backend untuk mengautentikasi permintaan API. Selain itu, Anda dapat mengganti setelan tingkat tahap untuk metode individual dan menentukan variabel tahap untuk meneruskan konteks lingkungan khusus tahap ke integrasi API saat runtime.
Tahapan memungkinkan kontrol versi yang kuat dari API Anda. Misalnya, Anda dapat menerapkan API ke test stage dan prod stage, dan menggunakan test stage sebagai test build dan menggunakan prod stage sebagai build stabil. Setelah pembaruan lulus tes, Anda dapat mempromosikan test panggung ke prod panggung. Promosi dapat dilakukan dengan memindahkan API ke prod tahap atau memperbarui nilai variabel tahap dari nama panggung test ke nama. prod
Di bagian ini, kita membahas cara menerapkan API dengan menggunakan konsol API Gateway
Topik
