Konsep Amazon API Gateway

Bagian berikut menjelaskan konsep pengantar untuk menggunakan API Gateway.

API Gateway

API Gateway adalah AWS layanan yang mendukung hal-hal berikut:

• Membuat, menerapkan, dan mengelola antarmuka pemrograman aplikasi RESTful (API) untuk mengekspos titik akhir HTTP backend, AWS Lambda fungsi, atau layanan lainnya. AWS

• Membuat, menerapkan, dan mengelola WebSocket API untuk mengekspos AWS Lambda fungsi atau AWS layanan lainnya.

• Memanggil metode API yang terbuka melalui HTTP frontend dan WebSocket titik akhir.

API Gerbang REST API

Kumpulan sumber daya HTTP dan metode yang terintegrasi dengan backend HTTP endpoints, fungsi Lambda, atau layanan lainnya. AWS Anda dapat menerapkan koleksi ini dalam satu atau lebih tahap. Biasanya, sumber daya API diatur dalam pohon sumber daya sesuai dengan logika aplikasi. Setiap sumber daya API dapat mengekspos satu atau lebih metode API yang memiliki kata kerja HTTP unik yang didukung oleh API Gateway. Untuk informasi selengkapnya, lihat Pilih antara REST API dan HTTP API.

API Gateway HTTP API

Kumpulan rute dan metode yang terintegrasi dengan backend HTTP endpoints atau fungsi Lambda. Anda dapat menerapkan koleksi ini dalam satu atau lebih tahap. Setiap rute dapat mengekspos satu atau lebih metode API yang memiliki kata kerja HTTP unik yang didukung oleh API Gateway. Untuk informasi selengkapnya, lihat Pilih antara REST API dan HTTP API.

API Gerbang WebSocket API

Kumpulan WebSocket rute dan kunci rute yang terintegrasi dengan titik akhir HTTP backend, fungsi Lambda, atau layanan lainnya. AWS Anda dapat menerapkan koleksi ini dalam satu atau lebih tahap. Metode API dipanggil melalui WebSocket koneksi frontend yang dapat Anda kaitkan dengan nama domain kustom terdaftar.

Penyebaran API

Sebuah snapshot point-in-time dari API Gateway API Anda. Agar tersedia bagi klien untuk digunakan, penerapan harus dikaitkan dengan satu atau beberapa tahapan API.

Pengembang API

AWS Akun Anda yang memiliki penyebaran API Gateway (misalnya, penyedia layanan yang juga mendukung akses terprogram).

Titik akhir API

Nama host untuk API di API Gateway yang diterapkan ke Wilayah tertentu. Nama host adalah dari formulir{api-id}.execute-api.{region}.amazonaws.com. Jenis titik akhir API berikut didukung:

• Edge-optimized Titik akhir API

• Titik akhir API pribadi

• Titik akhir API regional

Kunci API

String alfanumerik yang digunakan API Gateway untuk mengidentifikasi pengembang aplikasi yang menggunakan REST atau WebSocket API Anda. API Gateway dapat menghasilkan kunci API atas nama Anda, atau Anda dapat mengimpornya dari file CSV. Anda dapat menggunakan kunci API bersama dengan otor isasi Lambda atau rencana penggunaan untuk mengontrol akses ke API Anda.

Lihat titik akhir API.

Pemilik API

Lihat Pengembang API.

Tahap API

Referensi logis ke status siklus hidup API Anda (misalnya, 'dev', 'prod', 'beta', 'v2'). Tahap API diidentifikasi oleh ID API dan nama panggung.

Pengembang aplikasi

Pembuat aplikasi yang mungkin atau mungkin tidak memiliki AWS akun dan berinteraksi dengan API yang Anda, pengembang API, telah terapkan. Pengembang aplikasi adalah pelanggan Anda. Pengembang aplikasi biasanya diidentifikasi oleh kunci API.

URL Panggilan Balik

Ketika klien baru terhubung melalui WebSocket koneksi, Anda dapat memanggil integrasi di API Gateway untuk menyimpan URL callback klien. Anda kemudian dapat menggunakan URL callback itu untuk mengirim pesan ke klien dari sistem backend.

Portal pengembang

Aplikasi tempat penyedia API dapat membagikan API dan dokumentasi API mereka kepada konsumen API. API dikelompokkan ke dalam produk, yang merupakan kumpulan titik akhir REST API, dokumentasi API, dan dokumentasi produk tambahan.

Lihat Portal Gateway API.

Edge-optimized Titik akhir API

Nama host default API Gateway API yang digunakan ke Wilayah tertentu saat menggunakan CloudFront distribusi untuk memfasilitasi akses klien biasanya dari seluruh Wil AWS ayah. Permintaan API dialihkan ke CloudFront Point of Presence (POP) terdekat, yang biasanya meningkatkan waktu koneksi untuk klien yang beragam secara geografis.

Lihat titik akhir API.

Permintaan integrasi

Antarmuka internal rute WebSocket API atau metode REST API di API Gateway, di mana Anda memetakan badan permintaan rute atau parameter dan badan permintaan metode ke format yang diperlukan oleh backend.

Respon integrasi

Antarmuka internal rute WebSocket API atau metode REST API di API Gateway, di mana Anda memetakan kode status, header, dan payload yang diterima dari backend ke format respons yang dikembalikan ke aplikasi klien.

Template pemetaan

Sebuah skrip dalam Velocity Template Language (VTL) yang mengubah badan permintaan dari format data frontend ke format data backend, atau yang mengubah badan respons dari format data backend ke format data frontend. Template pemetaan dapat ditentukan dalam permintaan integrasi atau dalam respons integrasi. Mereka dapat mereferensikan data yang tersedia saat runtime sebagai variabel konteks dan tahap.

Pemetaan dapat sesederhana transform asi identitas yang melewati header atau body melalui integrasi apa adanya dari klien ke backend untuk permintaan. Hal yang sama berlaku untuk respons, di mana payload diteruskan dari backend ke klien.

Permintaan metode

Antarmuka publik dari metode API di API Gateway yang mendefinisikan parameter dan badan yang harus dikirim pengembang aplikasi dalam permintaan untuk mengakses backend melalui API.

Respon metode

Antarmuka publik REST API yang mendefinisikan kode status, header, dan model tubuh yang diharapkan pengembang aplikasi dalam tanggapan dari API.

Integrasi tiruan

Dalam integrasi tiruan, respons API dihasilkan dari API Gateway secara langsung, tanpa perlu backend integrasi. Sebagai pengembang API, Anda memutuskan bagaimana API Gateway menanggapi permintaan integrasi tiruan. Untuk ini, Anda mengonfigurasi permintaan integrasi metode dan respons integrasi untuk mengaitkan respons dengan kode status tertentu.

Model

Skema data yang menentukan struktur data permintaan atau payload respons. Model diperlukan untuk menghasilkan SDK API yang diketik dengan kuat. Ini juga digunakan untuk memvalidasi muatan. Model nyaman untuk menghasilkan template pemetaan sampel untuk memulai pembuatan template pemetaan produksi. Meskipun berguna, model tidak diperlukan untuk membuat template pemetaan.

Portal

Lihat Portal Pengembang.

Produk Portal

Layanan atau fungsi yang ingin Anda bagikan. Produk portal Anda adalah kumpulan titik akhir REST produk dan halaman produk. Titik akhir REST produk adalah titik akses ke produk portal Anda, dan terdiri dari jalur dan metode REST API dan tahap yang digunakan. Halaman produk adalah dokumentasi yang Anda berikan untuk menjelaskan bagaimana konsumen API dapat menggunakan titik akhir produk Anda. Anda dapat berbagi produk di seluruh AWS akun untuk menambahkannya ke portal.

Lihat Membuat produk.

API pribadi

Lihat T itik akhir API Pribadi.

Titik akhir API pribadi

Titik akhir API yang diekspos melalui titik akhir VPC antarmuka dan memungkinkan klien mengakses sumber daya API pribadi dengan aman di dalam VPC. API pribadi diisolasi dari internet publik, dan mereka hanya dapat diakses menggunakan titik akhir VPC untuk API Gateway yang telah diberikan akses.

Integrasi pribadi

Jenis integrasi API Gateway bagi klien untuk mengakses sumber daya di dalam VPC pelanggan melalui titik akhir REST API pribadi tanpa mengekspos sumber daya ke internet publik.

Integrasi Proxy

Konfigurasi integrasi API Gateway yang disederhanakan. Anda dapat mengatur integrasi proxy sebagai integrasi proxy HTTP atau integrasi proxy Lambda.

Untuk integrasi proxy HTTP, API Gateway meneruskan seluruh permintaan dan respons antara frontend dan backend HTTP. Untuk integrasi proxy Lambda, API Gateway mengirimkan seluruh permintaan sebagai input ke fungsi Lambda backend. API Gateway kemudian mengubah output fungsi Lambda menjadi respons HTTP frontend.

Di REST API, integrasi proxy paling sering digunakan dengan sumber daya proxy, yang diwakili oleh variabel jalur serakah (misalnya,{proxy+}) yang dikombinasikan dengan metode catch-allANY.

Buat cepat

Anda dapat menggunakan quick create untuk menyederhanakan pembuatan HTTP API. Quick create membuat API dengan integrasi Lambda atau HTTP, rute catch-all default, dan tahap default yang dikonfigurasi untuk menerapkan perubahan secara otomatis. Untuk informasi selengkapnya, lihat Buat API HTTP dengan menggunakan AWS CLI.

Titik akhir API regional

Nama host API yang digunakan ke Wilayah yang ditentukan dan dimaksudkan untuk melayani klien, seperti instans EC2, di Wilayah yang sama AWS . Permintaan API ditargetkan langsung ke Region-specific API Gateway API tanpa melalui CloudFront distribusi apa pun. Untuk permintaan In-region, titik akhir Regional melewati perjalanan pulang pergi yang tidak perlu ke distribusi. CloudFront

Selain itu, Anda dapat menerapkan perutean berbasis latensi pada titik akhir Regional untuk menyebarkan API ke beberapa Wilayah menggunakan konfigurasi titik akhir API Regional yang sama, menetapkan nama domain kustom yang sama untuk setiap API yang digunakan, dan mengonfigurasi catatan DNS berbasis latensi di Route 53 untuk merutekan permintaan klien ke Wilayah yang memiliki latensi terendah.

Lihat titik akhir API.

Rute

WebSocket Rute di API Gateway digunakan untuk mengarahkan pesan masuk ke integrasi tertentu, seperti AWS Lambda fungsi, berdasarkan konten pesan. Ketika Anda menentukan WebSocket API Anda, Anda menentukan kunci rute dan backend integrasi. Kunci rute adalah atribut dalam badan pesan. Ketika kunci rute dicocokkan dalam pesan masuk, backend integrasi dipanggil.

Rute default juga dapat diatur untuk kunci rute yang tidak cocok atau untuk menentukan model proxy yang meneruskan pesan melalui apa adanya ke komponen backend yang melakukan routing dan memproses permintaan.

Permintaan rute

Antarmuka publik dari metode WebSocket API di API Gateway yang mendefinisikan badan yang harus dikirim pengembang aplikasi dalam permintaan untuk mengakses backend melalui API.

Respon rute

Antarmuka publik WebSocket API yang mendefinisikan kode status, header, dan model tubuh yang diharapkan pengembang aplikasi dari API Gateway.

Rencana penggunaan

Paket penggunaan menyediakan klien API yang dipilih dengan akses ke satu atau beberapa REST atau WebSocket API yang digunakan. Anda dapat menggunakan paket penggunaan untuk mengonfigurasi batas pembatasan dan kuota, yang diberlakukan pada kunci API klien individual.

WebSocket koneksi

API Gateway mempertahankan koneksi persisten antara klien dan API Gateway itu sendiri. Tidak ada koneksi persisten antara API Gateway dan integrasi backend seperti fungsi Lambda. Layanan backend dipanggil sesuai kebutuhan, berdasarkan konten pesan yang diterima dari klien.