Terapkan REST APIs di API Gateway - APIGerbang Amazon

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

Terapkan REST APIs di API Gateway

Setelah membuatAPI, Anda harus menerapkannya agar dapat dipanggil oleh pengguna Anda.

Untuk menerapkanAPI, Anda membuat API penerapan dan mengaitkannya dengan panggung. Tahap adalah referensi logis ke status siklus hidup Anda API (misalnya,,, dev prodbeta,v2). APItahapan diidentifikasi dengan API ID dan nama panggung. Mereka termasuk dalam URL yang Anda gunakan untuk memanggil. API Setiap tahap adalah referensi bernama untuk penyebaran API dan dibuat tersedia untuk aplikasi klien untuk memanggil.

penting

Setiap kali Anda memperbaruiAPI, Anda harus memindahkan API ke tahap yang ada atau ke tahap baru. Memperbarui API termasuk memodifikasi rute, metode, integrasi, otorisasi, kebijakan sumber daya, dan hal lain selain pengaturan tahap.

Saat Anda API berkembang, Anda dapat terus menerapkannya ke tahapan yang berbeda sebagai versi yang berbeda dari. API Anda juga dapat menerapkan API pembaruan Anda sebagai penerapan rilis kenari. Ini memungkinkan API klien Anda untuk mengakses, pada tahap yang sama, versi produksi melalui rilis produksi, dan versi terbaru melalui rilis kenari.

Untuk memanggil deployedAPI, klien mengirimkan permintaan terhadap anAPI. URL URLIni ditentukan oleh protokol (S) atau HTTP (WSS)), nama host, nama panggung, dan (untuk RESTAPIs) jalur sumber daya. API Nama host dan nama panggung menentukan API basisURL.

Menggunakan API nama domain default, basis URL REST API (misalnya) dalam tahap tertentu ({stageName}) adalah dalam format berikut:

https://{restapi-id}.execute-api.{region}.amazonaws.com/{stageName}

Untuk membuat basis default URL lebih user-friendly, Anda dapat membuat nama domain kustom (misalnya,api.example.com) untuk mengganti nama host default. API API Untuk mendukung beberapa APIs di bawah nama domain kustom, Anda harus memetakan API tahap ke jalur dasar.

Dengan nama domain kustom {api.example.com} dan API tahap yang dipetakan ke jalur dasar ({basePath}) di bawah nama domain kustom, basis URL a REST API menjadi sebagai berikut:

https://{api.example.com}/{basePath}

Untuk setiap tahap, Anda dapat mengoptimalkan API kinerja dengan menyesuaikan batas pembatasan permintaan tingkat akun default dan mengaktifkan caching. API Anda juga dapat mengaktifkan pencatatan untuk API panggilan ke CloudTrail atau CloudWatch, dan dapat memilih sertifikat klien untuk backend untuk mengautentikasi permintaan. API Selain itu, Anda dapat mengganti pengaturan tingkat tahap untuk metode individual dan menentukan variabel tahap untuk meneruskan konteks lingkungan spesifik tahap ke integrasi saat runtime. API

Tahapan memungkinkan kontrol versi yang kuat dari AndaAPI. 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 atau memanggil APIGateway REST API. Untuk menggunakan alat lain, lihat dokumentasi AWS CLIatau file AWS SDK.