Tanya Jawab Amazon API Gateway

Amazon API Gateway adalah layanan yang dikelola secara penuh yang memudahkan pengembang menerbitkan, memelihara, memantau, dan mengamankan API pada segala skala. Dengan beberapa klik pada AWS Management Console, Anda dapat membuat API yang berfungsi sebagai “pintu depan” bagi aplikasi untuk mengakses data, logika bisnis, atau fungsionalitas dari layanan back-end Anda, seperti aplikasi yang berjalan di Amazon Elastic Compute Cloud (Amazon EC2), Amazon Elastic Container Service (Amazon ECS), atau AWS Elastic Beanstalk, kode yang berjalan di AWS Lambda, atau aplikasi web apa pun. Amazon API Gateway menangani semua tugas yang terlibat dalam penerimaan dan pemrosesan hingga ratusan ribu panggilan API secara bersamaan, termasuk pengelolaan lalu lintas, otorisasi dan kendali akses, pemantauan, serta pengelolaan versi API. Amazon API Gateway tidak memiliki biaya minimum atau uang muka. Untuk API HTTP dan REST, Anda hanya membayar panggilan API yang diterima dan jumlah data yang ditransfer keluar. Untuk API WebSocket, Anda hanya membayar untuk pesan yang dikirim dan yang diterima serta saat pengguna/perangkat tersambung ke API WebSocket.

Amazon API Gateway menyediakan pengembang layanan bayar sesuai pemakaian yang sederhana, fleksibel, dan terkelola penuh yang menangani semua aspek pembuatan dan pengoperasian API andal untuk back end aplikasi. Dengan API Gateway, Anda dapat meluncurkan layanan baru dengan lebih cepat dan dengan investasi lebih rendah sehingga Anda dapat fokus membangun layanan bisnis utama Anda. API Gateway dibuat untuk membantu Anda dengan beberapa aspek pembuatan dan pengelolaan API:

1) Pengukuran. API Gateway membantu Anda menentukan paket yang mengukur dan membatasi akses pengembang pihak ketiga ke API Anda. Anda dapat menentukan sekumpulan paket, mengonfigurasi pembatasan, serta batas kuota per basis kunci API. API Gateway secara otomatis akan mengukur lalu lintas ke API Anda dan memungkinkan Anda mengekstrak data penggunaan untuk setiap kunci API.

2) Keamanan. API Gateway memberi Anda beberapa alat untuk melakukan otorisasi akses ke API dan mengendalikan akses operasi layanan Anda. API Gateway memungkinkan Anda menggunakan administrasi AWS dan alat keamanan, seperti AWS Identity and Access Management (IAM) dan Amazon Cognito, untuk melakukan otorisasi akses ke API Anda. API Gateway dapat mewakili Anda untuk memverifikasi panggilan API yang ditandatangani menggunakan cara yang sama seperti yang digunakan AWS untuk API-nya sendiri. Dengan pengotorisasi khusus yang tertulis sebagai fungsi AWS Lambda, API Gateway juga dapat membantu Anda memverifikasi token pembawa yang masuk, sehingga menghilangkan masalah otorisasi dari kode backend Anda.

3) Ketahanan. API Gateway membantu Anda mengelola lalu lintas dengan pembatasan kecepatan, sehingga operasi back-end dapat menahan terhentinya lalu lintas. API Gateway juga membantu Anda meningkatkan kinerja API dan latensi yang dialami oleh pengguna akhir Anda dengan melakukan cache output panggilan API untuk menghindari pemanggilan back end setiap saat.

4) Pemantauan Operasi. Setelah API diterbitkan dan digunakan, API Gateway memberi Anda dasbor metrik untuk mengawasi panggilan ke layanan Anda. Dasbor API Gateway, melalui integrasi dengan Amazon CloudWatch, memberi Anda metrik kinerja backend yang meliputi panggilan API, data latensi, dan laju kesalahan. Anda dapat mengaktifkan metrik terperinci untuk setiap metode dalam API Anda dan juga menerima log kesalahan, akses, atau debug di CloudWatch Logs.

5) Manajemen Siklus Hidup. Setelah API diterbitkan, Anda akan sering perlu mem-build dan menguji versi baru yang meningkatkan atau menambahkan fungsionalitas baru. API Gateway memungkinkan Anda mengoperasikan beberapa versi API dan beberapa tahap untuk setiap versi secara simultan, sehingga aplikasi yang sudah ada dapat terus melakukan panggilan versi sebelumnya setelah versi API baru diterbitkan.

6) Dirancang untuk Developer. API Gateway memungkinkan Anda dengan cepat membuat API dan menetapkan konten statis untuk respons mereka dengan tujuan mengurangi usaha pengembangan antartim dan waktu ke pasar untuk aplikasi Anda. Tim yang bergantung pada API Anda dapat memulai pengembangan selagi Anda mem-build proses backend.

7) Komunikasi Dua Arah Waktu Nyata. Build aplikasi komunikasi dua arah seperti aplikasi obrolan, dasbor streaming, dan notifikasi tanpa perlu menjalankan atau mengelola server apa pun. API Gateway mempertahankan koneksi persisten di antara pengguna yang tersambung dan memungkinkan transfer pesan di antara pengguna tersebut.

Amazon API Gateway menawarkan dua opsi untuk membuat API RESTful, API HTTP, dan API REST, termasuk opsi untuk membuat API WebSocket.

API HTTP: API HTTP dioptimalkan untuk membangun API yang memproksi fungsi AWS Lambda atau backend HTTP sehingga cocok untuk beban kerja nirserver. API HTTP saat ini tidak menawarkan fungsi manajemen API.

API REST: API REST menawarkan fungsionalitas proksi API dan fitur manajemen API dalam satu solusi. API REST menawarkan fitur manajemen API seperti rencana penggunaan, kunci API, penerbitan, dan monetisasi API.

API WebSocket: API WebSocket mempertahankan koneksi persisten di antara klien yang terhubung untuk memungkinkan komunikasi pesan waktu nyata. Dengan API WebSocket di API Gateway, Anda dapat menentukan integrasi backend dengan fungsi AWS Lambda, Amazon Kinesis, atau titik akhir HTTP apa pun untuk diaktifkan saat pesan diterima dari klien yang tersambung.

Untuk memulai dengan API HTTP, Anda dapat menggunakan konsol Amazon API Gateway, AWS CLI, AWS SDK, atau AWS CloudFormation. Untuk mempelajari lebih lanjut tentang memulai dengan API HTTP, lihat dokumentasi kami.

Untuk memulai dengan API REST, Anda dapat menggunakan konsol Amazon API Gateway, AWS CLI, atau AWS SDK. Untuk mempelajari lebih lanjut tentang memulai dengan API REST, lihat dokumentasi kami.

Anda dapat membangun API RESTful menggunakan API HTTP dan API REST di Amazon API Gateway.

API HTTP dioptimalkan untuk membangun API yang berproxy ke fungsi AWS Lambda atau HTTP backend, sehingga cocok untuk beban kerja tanpa server. API HTTP merupakan alternatif yang lebih murah dan lebih cepat dibandingkan API REST, tetapi mereka saat ini tidak mendukung fungsi manajemen API. API REST ditujukan untuk API yang memerlukan fungsionalitas proxy API dan fitur manajemen dalam satu solusi.

API HTTP cocok untuk:

1. Membangun API proxy untuk AWS Lambda atau titik akhir HTTP mana pun.
2. Membangun API modern yang dilengkapi otorisasi OIDC dan OAuth 2 
3. Beban kerja yang kemungkinan akan tumbuh sangat besar
4. API untuk beban kerja yang sensitif latensi

1. Pelanggan yang ingin membayar satu harga untuk set lengkap fitur yang diperlukan untuk membangun, mengelola, dan menerbitkan API mereka. 

API HTTP dilengkapi standar dukungan CORS, OIDC, dan OAuth2 untuk otentikasi dan otorisasi, serta penerapan otomatis dalam tahapannya.

Ya, Anda dapat mengimpor definisi API menggunakan OpenAPI 3. Ini akan menghasilkan pembuatan rute, integrasi, dan model API. Untuk informasi lebih lanjut mengenai mengimpor definisi OpenAPI, baca dokumentasi kami.

Untuk memigrasikan API REST Anda saat ini ke API HTTP di Amazon API Gateway, lakukan hal beirkut:

1. Periksa bahwa semua fitur yang Anda perlukan tersedia di HTTP. Untuk melihat daftar fitur lengkap, baca dokumentasi kami. 
2. Masuk ke API REST Anda dan ekspor definisi OpenAPI dari API REST Anda.
3. Masuk ke API HTTP Anda dan impor definisi OpenAPI dari langkah sebelumnya
4. Uji apakah fungsi API berjalan semestinya
5. Perbarui client Anda dengan URL baru

Meskipun API Anda dapat bekerja, Anda mungkin menemukan ada fitur yang hilang. Untuk mengidentifikasi fitur yang hilang, tinjau bidang Info, Warning, dan Error dari operasi Import. Untuk informasi lebih lanjut tentang memigrasi API REST ke API HTTP, lihat dokumentasi kami.

Pertama, masuk ke REST Anda dan ekspor definisi OpenAPI dari API REST Anda. Kemudian, masuk ke API HTTP Anda dan impor definisi OpenAPI dari langkah sebelumnya Meskipun API Anda dapat bekerja, Anda mungkin menemukan ada fitur yang hilang. Untuk mengidentifikasi fitur yang hilang, tinjau bidang Info, Warning, dan Error dari operasi Import. AWS CLI akan mengembalikan informasi tentang API Anda dalam bidang info dan peringatan. Untuk informasi lebih lanjut, baca dokumentasi kami.

Untuk memulai, Anda dapat membuat API WebSocket menggunakan AWS Management Console, AWS CLI, atau AWS SDK. Anda selanjutnya dapat menentukan perutean WebSocket untuk menunjukkan layanan backend seperti AWS Lambda, Amazon Kinesis, atau titik akhir HTTP apa pun untuk diaktifkan berdasarkan konten pesan. Baca dokumentasi untuk mulai menggunakan API WebSocket di API Gateway.

Ya, semua API yang dibuat dengan Amazon API Gateway hanya mengeluarkan endpoint HTTPS. Amazon API Gateway tidak mendukung endpoint (HTTP) tak terenkripsi. Secara default, Amazon API Gateway menetapkan domain internal pada API yang secara otomatis menggunakan sertifikat Amazon API Gateway. Saat mengonfigurasikan API agar berjalan di bawah nama domain kustom, Anda dapat memberikan sertifikat Anda sendiri untuk domain tersebut.

API yang dibuat di Amazon API Gateway dapat menerima muatan apa pun yang dikirim melalui HTTP untuk API HTTP, API REST, dan API WebSocket. Format data biasanya termasuk JSON, XML, parameter string kueri, dan header permintaan. Anda dapat menyatakan jenis konten apa pun untuk respons API Anda, lalu menggunakan template transformasi untuk mengubah respons backend menjadi format yang dikehendaki.

Amazon API Gateway dapat mengeksekusi fungsi AWS Lambda di akun Anda, memulai mesin status AWS Step Functions, atau memanggil endpoint HTTP yang di-host pada AWS Elastic Beanstalk, Amazon EC2, dan juga operasi berbasis HTTP yang di-host non-AWS yang dapat diakses melalui Internet publik. API Gateway juga memungkinkan Anda menentukan template pemetaan untuk menghasilkan konten statis dikembalikan, yang membantu Anda membuat tiruan (mock) API bahkan sebelum backend siap. Anda juga dapat mengintegrasikan API Gateway dengan layanan AWS lainnya secara langsung – misalnya, Anda dapat mengekspos metode API pada API Gateway yang mengirimkan data secara langsung ke Amazon Kinesis.

API Gateway menghasilkan SDK kustom untuk pengembangan aplikasi seluler dengan Android dan iOS (Swift dan Objective-C), serta untuk pengembangan aplikasi web dengan JavaScript. API Gateway juga mendukung pembuatan SDK untuk Ruby dan Java. Setelah API dan modelnya ditentukan dalam API Gateway, Anda dapat menggunakan konsol AWS atau API dari API Gateway untuk menghasilkan dan mengunduh SDK klien. SDK klien hanya dibuat untuk API REST di Amazon API Gateway.

Untuk melihat tempat API HTTP, API REST, API WebSocket tersedia, lihat tabel AWS Region di sini.

Melalui konsol Amazon API Gateway, Anda dapat menentukan API REST beserta sumber daya dan metode terkait, mengelola masa aktif API, menghasilkan SDK klien, dan melihat metrik API. Anda juga dapat menggunakan konsol API Gateway untuk menentukan paket penggunaan API, mengelola kunci API pengembang, serta mengonfigurasi pembatasan kecepatan dan batas kuota. Semua tindakan yang sama tersedia melalui API dari API Gateway.

Sumber daya adalah objek tertulis yang merupakan bagian dari domain API Anda. Setiap sumber daya mungkin memiliki model data terkait, hubungan ke sumber daya lain, dan dapat merespons metode berbeda. Anda juga dapat menentukan sumber daya sebagai variabel untuk menghadang permintaan menjadi beberapa sumber daya turunan.

Setiap sumber daya di dalam REST API dapat mendukung satu atau beberapa metode HTTP standar. Anda menentukan verba mana yang harus didukung untuk setiap sumber daya (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS) beserta implementasinya. Sebagai contoh, GET untuk sumber daya mobil harus menghasilkan daftar mobil. Untuk menyambungkan semua metode di dalam sumber daya menjadi satu titik akhir backend, API Gateway juga mendukung metode “ANY” khusus.

Paket penggunaan membantu Anda menyatakan paket untuk developer pihak ketiga yang membatasi akses hanya pada API tertentu, menentukan pembatasan kecepatan dan permintaan batas kuota, serta menghubungkan mereka dengan kunci API. Anda juga dapat mengekstrak data pemanfaatan dengan dasar kunci per-API untuk menganalisis penggunaan API dan menghasilkan dokumen penagihan. Misalnya, Anda dapat membuat paket basic, professional, dan korporasi – Anda dapat mengonfigurasi paket penggunaan dasar agar hanya mengizinkan 1.000 permintaan per hari dan maksimum 5 permintaan per detik (RPS).

Dengan Amazon API Gateway, setiap REST API dapat memiliki beberapa tahapan. Tahapan ditujukan untuk membantu siklus aktif pengembangan API – misalnya, setelah Anda membuat API dan men-deploy-nya ke tahap pengembangan, atau saat Anda telah siap produksi, Anda dapat men-deploy API tersebut ke tahap produksi.

Dalam Amazon API Gateway, tahapan mirip dengan tag. Tahapan menentukan jalur di mana penerapan dapat diakses. Contohnya, Anda dapat menentukan tahap pengembangan dan men-deploy API mobil ke tahapan tersebut. Sumber daya dapat diakses di https://www.myapi.com/dev/cars. Anda juga dapat mengatur nama domain kustom untuk menuju langsung ke suatu tahap, sehingga Anda tidak perlu menggunakan parameter jalur tambahan. Misalnya, jika Anda menunjuk myapi.com langsung ke tahap pengembangan, Anda dapat mengakses sumber daya mobil di https://www.myapi.com/cars. Tahapan dapat dikonfigurasikan menggunakan variabel yang dapat diakses dari konfigurasi API atau template pemetaan Anda.

Variabel tahapan memungkinkan Anda menentukan pasangan kunci/nilai dari nilai konfigurasi yang terkait dengan suatu tahap. Nilai-nilai ini, sama seperti variabel lingkungan, dapat digunakan dalam konfigurasi API Anda. Misalnya, Anda dapat menentukan titik akhir HTTP untuk integrasi metode Anda sebagai suatu variabel tahapan, dan menggunakan variabel dalam konfigurasi API Anda sebagai ganti proses hardcode titik akhir – hal ini memungkinkan Anda menggunakan titik akhir yang berbeda untuk setiap tahapan (misal dev, beta, prod) dengan konfigurasi API yang sama. Variabel tahapan juga dapat diakses dalam template pemetaan dan dapat digunakan untuk meneruskan parameter konfigurasi ke Lambda atau backend HTTP Anda.

Kebijakan Sumber Daya adalah dokumen kebijakan JSON yang Anda lampirkan pada API untuk mengontrol apakah prinsip yang ditentukan (biasanya pengguna atau peran IAM) dapat meminta API. Anda dapat menggunakan Kebijakan Sumber Daya untuk mengaktifkan pengguna dari akun AWS yang berbeda untuk mengakses API Anda dengan aman, atau memungkinkan API agar dapat diminta hanya dari rentang alamat IP sumber atau blok CIDR tertentu. Kebijakan Sumber Daya dapat digunakan dengan API REST di Amazon API Gateway.

Amazon API Gateway menyimpan riwayat penerapan Anda. Dengan menggunakan Amazon API Gateway atau konsol, Anda dapat melakukan pengembalian suatu tahapan ke penerapan sebelumnya kapan saja.

Ya. Anda dapat menggunakan alat pengimpor Swagger sumber terbuka kami untuk mengimpor definisi API Swagger Anda ke Amazon API Gateway. Dengan alat pengimpor Swagger, Anda dapat membuat serta men-deploy API baru, juga memperbarui yang sudah ada.

Anda dapat memonetisasi API di API Gateway dengan menerbitkannya sebagai produk di AWS Marketplace. Pertama-tama Anda harus terdaftar sebagai penjual di AWS Marketplace, lalu ajukan paket penggunaan Anda pada API Gateway sebagai produk. Baca di sini untuk mempelajari selengkapnya tentang Monetisasi API.

API Gateway menawarkan kemampuan untuk membuat, memperbarui, dan menghapus dokumentasi yang terkait dengan setiap porsi API Anda, seperti metode dan sumber daya. Anda dapat mengakses API terkait dokumentasi melalui AWS SDK, CLI, melalui panggilan RESTful, atau dengan mengedit string dokumentasi secara langsung di konsol API Gateway. Dokumentasi juga dapat diimpor sebagai file Swagger, baik sebagai bagian API atau secara terpisah, yang memungkinkan Anda menambahkan atau memperbarui dokumentasi tanpa mengganggu definisi API. API Gateway sesuai dengan spesifikasi Open API untuk dokumentasi yang diimpor dari, atau diekspor ke, file Swagger. Dokumentasi didukung untuk API REST di API Gateway.

Selain untuk menawarkan dukungan dokumentasi API sesuai standar, API Gateway juga menambahkan dukungan turunan dokumentasi, yang mempermudah penentuan string dokumentasi setelahnya, kemudian menggunakannya di berbagai tempat. Turunan menyederhanakan proses penentuan dokumentasi API, dan dapat dikonversikan ke representasi standar saat mengekspor API sebagai file Swagger.

Ya, Anda dapat menerapkan Kebijakan Sumber Daya pada API untuk membatasi akses ke Amazon VPC atau titik akhir VPC tertentu. Anda juga dapat memberikan Amazon VPC atau titik akhir VPC dari akses akun berbeda ke API Pribadi menggunakan Kebijakan Sumber Daya.