Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Bagian kasus penggunaan berikut menyajikan ikhtisar tentang berbagai jenis API Gateway APIs dan berbagai jenis pengembang yang menggunakan API Gateway. Untuk informasi lebih rinci tentang perbedaan antara REST APIs dan HTTP APIs, lihatPilih antara REST APIs dan HTTP APIs.
Topik
Gunakan API Gateway untuk membuat REST APIs
API API Gateway REST terdiri dari sumber daya dan metode. Resource adalah entitas logis yang dapat diakses aplikasi melalui jalur sumber daya. Metode sesuai dengan permintaan REST API yang dikirimkan oleh pengguna API Anda dan respons yang dikembalikan ke pengguna.
Misalnya, /incomes
bisa menjadi jalur sumber daya yang mewakili pendapatan pengguna aplikasi. Sumber daya dapat memiliki satu atau lebih operasi yang ditentukan oleh kata kerja HTTP yang sesuai seperti GET, POST, PUT, PATCH, dan DELETE. Kombinasi jalur sumber daya dan operasi mengidentifikasi metode API. Misalnya, POST /incomes
metode dapat menambahkan pendapatan yang diperoleh oleh penelepon, dan GET /expenses
metode dapat menanyakan biaya yang dilaporkan yang dikeluarkan oleh penelepon.
Aplikasi tidak perlu tahu di mana data yang diminta disimpan dan diambil dari backend. Di API Gateway REST APIs, frontend dienkapsulasi oleh permintaan metode dan respons metode. Antarmuka API dengan backend melalui permintaan integrasi dan respons integrasi.
Misalnya, dengan DynamoDB sebagai backend, pengembang API menyiapkan permintaan integrasi untuk meneruskan permintaan metode masuk ke backend yang dipilih. Penyiapan mencakup spesifikasi tindakan DynamoDB yang sesuai, peran dan kebijakan IAM yang diperlukan, dan transformasi data input yang diperlukan. Backend mengembalikan hasilnya ke API Gateway sebagai respons integrasi.
Untuk merutekan respons integrasi ke respons metode yang sesuai (dari kode status HTTP yang diberikan) ke klien, Anda dapat mengonfigurasi respons integrasi untuk memetakan parameter respons yang diperlukan dari integrasi ke metode. Anda kemudian menerjemahkan format data keluaran backend ke format frontend, jika perlu. API Gateway memungkinkan Anda untuk menentukan skema atau model untuk payload
API Gateway menyediakan fungsionalitas manajemen REST API seperti berikut ini:
-
Support untuk membuat SDKs dan membuat dokumentasi API menggunakan ekstensi API Gateway ke OpenAPI
-
Pelambatan permintaan HTTP
Gunakan API Gateway untuk membuat HTTP APIs
HTTP APIs memungkinkan Anda untuk membuat RESTful APIs dengan latensi yang lebih rendah dan biaya lebih rendah daripada REST APIs.
Anda dapat menggunakan HTTP APIs untuk mengirim permintaan ke AWS Lambda fungsi atau ke titik akhir HTTP yang dapat dirutekan secara publik.
Misalnya, Anda dapat membuat API HTTP yang terintegrasi dengan fungsi Lambda di backend. Saat klien memanggil API Anda, API Gateway mengirimkan permintaan ke fungsi Lambda dan mengembalikan respons fungsi ke klien.
HTTP APIs mendukung OpenID Connect dan otorisasi OAuth
Untuk mempelajari selengkapnya, lihat Pilih antara REST APIs dan HTTP APIs.
Gunakan API Gateway untuk membuat WebSocket APIs
Dalam WebSocket API, klien dan server dapat mengirim pesan satu sama lain kapan saja. Server backend dapat dengan mudah mendorong data ke pengguna dan perangkat yang terhubung, menghindari kebutuhan untuk menerapkan mekanisme pemungutan suara yang kompleks.
Misalnya, Anda dapat membuat aplikasi tanpa server menggunakan API Gateway WebSocket API dan mengirim serta menerima pesan AWS Lambda ke dan dari pengguna individu atau grup pengguna di ruang obrolan. Atau Anda dapat memanggil layanan backend seperti, Amazon AWS Lambda Kinesis, atau titik akhir HTTP berdasarkan konten pesan.
Anda dapat menggunakan API Gateway WebSocket APIs untuk membangun aplikasi komunikasi real-time yang aman tanpa harus menyediakan atau mengelola server apa pun untuk mengelola koneksi atau pertukaran data skala besar. Kasus penggunaan yang ditargetkan mencakup aplikasi waktu nyata seperti berikut ini:
-
Aplikasi obrolan
-
Dasbor real-time seperti ticker saham
-
Peringatan dan notifikasi waktu nyata
API Gateway menyediakan fungsionalitas manajemen WebSocket API seperti berikut ini:
-
Pemantauan dan pembatasan koneksi dan pesan
-
Menggunakan AWS X-Ray untuk melacak pesan saat mereka melakukan perjalanan melalui layanan APIs to backend
-
Integrasi mudah dengan titik akhir HTTP/HTTPS
Siapa yang menggunakan API Gateway?
Ada dua jenis pengembang yang menggunakan API Gateway: pengembang API dan pengembang aplikasi.
Pengembang API membuat dan menerapkan API untuk mengaktifkan fungsionalitas yang diperlukan di API Gateway. Pengembang API harus menjadi pengguna di AWS akun yang memiliki API.
Pengembang aplikasi membangun aplikasi yang berfungsi untuk memanggil AWS layanan dengan menjalankan API REST WebSocket atau yang dibuat oleh pengembang API di API Gateway.
Pengembang aplikasi adalah pelanggan pengembang API. Pengembang aplikasi tidak perlu memiliki AWS akun, asalkan API tidak memerlukan izin IAM atau mendukung otorisasi pengguna melalui penyedia identitas federasi pihak ketiga yang didukung oleh federasi identitas kumpulan pengguna Amazon Cognito. Penyedia identitas tersebut termasuk Amazon, kumpulan pengguna Amazon Cognito, Facebook, dan Google.
Membuat dan mengelola API Gateway API
Pengembang API bekerja dengan komponen layanan API Gateway untuk manajemen API, bernamaapigateway
, untuk membuat, mengonfigurasi, dan menerapkan API.
Sebagai pengembang API, Anda dapat membuat dan mengelola API dengan menggunakan konsol API Gateway, yang dijelaskan dalamMemulai dengan API Gateway, atau dengan memanggilReferensi API. Ada beberapa cara untuk memanggil API ini. Mereka termasuk menggunakan AWS Command Line Interface (AWS CLI), atau dengan menggunakan AWS SDK. Selain itu, Anda dapat mengaktifkan pembuatan API dengan AWS CloudFormation templat atau (dalam kasus REST APIs dan HTTP APIs)Buka API ekstensi untuk API Gateway.
Untuk daftar Wilayah tempat API Gateway tersedia, serta titik akhir layanan kontrol terkait, lihat Titik Akhir dan Kuota Amazon API Gateway.
Memanggil API Gateway API
Pengembang aplikasi bekerja dengan komponen layanan API Gateway untuk eksekusi API, bernamaexecute-api
, untuk memanggil API yang dibuat atau diterapkan di API Gateway. Entitas pemrograman yang mendasarinya diekspos oleh API yang dibuat. Ada beberapa cara untuk memanggil API semacam itu. Untuk mempelajari selengkapnya, lihat Memanggil REST API di API Gateway dan Memohon WebSocket APIs.