Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
APIKasus penggunaan gateway
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 HTTPAPIs, lihatPilih antara REST APIs dan HTTP APIs.
Topik
Gunakan API Gateway untuk membuat REST APIs
APIGateway REST API terdiri dari sumber daya dan metode. Resource adalah entitas logis yang dapat diakses aplikasi melalui jalur sumber daya. Metode sesuai dengan REST API permintaan yang dikirimkan oleh pengguna Anda API dan respons dikembalikan ke pengguna.
Misalnya, /incomes
bisa menjadi jalur sumber daya yang mewakili pendapatan pengguna aplikasi. Sumber daya dapat memiliki satu atau lebih operasi yang didefinisikan oleh HTTP kata kerja yang sesuai sepertiGET,,POST, PUTPATCH, danDELETE. 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 RESTAPIs, frontend dienkapsulasi oleh permintaan metode dan respons metode. APIAntarmuka dengan backend melalui permintaan integrasi dan tanggapan integrasi.
Misalnya, dengan DynamoDB sebagai backend, API pengembang 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 HTTP status tertentu) 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. APIGateway memungkinkan Anda untuk menentukan skema atau model untuk payload
APIGateway menyediakan fungsionalitas REST API manajemen seperti berikut ini:
-
Support untuk membuat SDKs dan membuat API dokumentasi menggunakan ekstensi API Gateway ke Open API
-
Pelambatan permintaan HTTP
Gunakan API Gateway untuk membuat HTTP APIs
HTTPAPIsmemungkinkan Anda untuk membuat RESTful APIs dengan latensi yang lebih rendah dan biaya lebih rendah daripada RESTAPIs.
Anda dapat menggunakan HTTP APIs untuk mengirim permintaan ke AWS Lambda fungsi atau ke titik akhir yang dapat dirutekan HTTP secara publik.
Misalnya, Anda dapat membuat HTTP API yang terintegrasi dengan fungsi Lambda di backend. Saat klien memanggil AndaAPI, API Gateway mengirimkan permintaan ke fungsi Lambda dan mengembalikan respons fungsi ke klien.
HTTPAPIsmendukung OpenID Connect dan otorisasi OAuth
Untuk mempelajari selengkapnya, lihat Pilih antara REST APIs dan HTTP APIs.
Gunakan API Gateway untuk membuat WebSocket APIs
Dalam a WebSocket API, klien dan server dapat saling 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 membangun aplikasi tanpa server menggunakan API Gateway WebSocket API dan AWS Lambda untuk mengirim dan menerima pesan ke dan dari pengguna individu atau grup pengguna di ruang obrolan. Atau Anda dapat memanggil layanan backend seperti, Amazon AWS Lambda Kinesis, atau titik HTTP akhir 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
APIGateway menyediakan fungsionalitas WebSocket API manajemen 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 HTTP dengan/titik HTTPS akhir
Siapa yang menggunakan API Gateway?
Ada dua jenis pengembang yang menggunakan API Gateway: API pengembang dan pengembang aplikasi.
APIPengembang membuat dan menyebarkan API untuk mengaktifkan fungsionalitas yang diperlukan di API Gateway. APIPengembang harus menjadi pengguna di AWS akun yang memiliki. API
Pengembang aplikasi membangun aplikasi yang berfungsi untuk memanggil AWS layanan dengan memanggil WebSocket atau REST API dibuat oleh API pengembang di API Gateway.
Pengembang aplikasi adalah pelanggan API pengembang. Pengembang aplikasi tidak perlu memiliki AWS akun, asalkan tidak memerlukan IAM izin atau mendukung otorisasi pengguna melalui penyedia identitas federasi pihak ketiga yang didukung oleh federasi identitas kumpulan pengguna Amazon Cognito. API Penyedia identitas tersebut termasuk Amazon, kumpulan pengguna Amazon Cognito, Facebook, dan Google.
Membuat dan mengelola API Gateway API
APIPengembang bekerja dengan komponen layanan API Gateway untuk API manajemen, bernamaapigateway
, untuk membuat, mengkonfigurasi, dan menyebarkan fileAPI.
Sebagai API pengembang, Anda dapat membuat dan mengelola API dengan menggunakan konsol API Gateway, dijelaskan dalamMemulai dengan API Gateway, atau dengan memanggilReferensi API. Ada beberapa cara untuk menyebut iniAPI. Mereka termasuk menggunakan AWS Command Line Interface (AWS CLI), atau dengan menggunakan AWS SDK. Selain itu, Anda dapat mengaktifkan API pembuatan dengan AWS CloudFormation templat atau (dalam kasus REST APIs dan HTTPAPIs)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 API eksekusi, bernamaexecute-api
, untuk memanggil API yang dibuat atau diterapkan di API Gateway. Entitas pemrograman yang mendasarinya diekspos oleh yang dibuatAPI. Ada beberapa cara untuk memanggil seperti ituAPI. Untuk mempelajari selengkapnya, lihat Memanggil REST API di API Gateway dan Memanggil API WebSocket .