Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Portal API Gateway
Anda dapat menggunakan portal API Gateway untuk membagikan dokumentasi Anda APIs dan API dengan konsumen API di halaman web. Sebuah portal berisi satu set produk portal. Setiap produk portal adalah pengelompokan logis REST APIs dan berisi dokumentasi yang Anda buat dan publikasikan untuk konsumen API Anda. Halaman produk dalam portal berisi dokumentasi khusus di tingkat produk portal. Halaman endpoint REST produk berisi dokumentasi untuk masing-masing REST APIs dan jalur, metode, dan tahap REST API. Kombinasi halaman produk dan halaman akhir REST produk menyediakan dokumentasi lengkap untuk memungkinkan konsumen API mempelajari cara mulai menggunakan REST APIs Anda.
Gunakan portal untuk melakukan hal berikut:
-
Gunakan API Gateway untuk seluruh siklus hidup API Anda, mulai dari membuat hingga mendokumentasikan dan APIs mendistribusikannya.
Bagikan produk portal di seluruh AWS akun.
-
Sesuaikan dan bagikan lokasi pusat untuk produk portal Anda dan sediakan halaman produk.
Pertimbangan-pertimbangan
Pertimbangan berikut dapat memengaruhi penggunaan portal API Gateway Anda:
Anda hanya dapat membuat portal untuk berbagi REST APIs.
-
Portal dibuat di tingkat AWS Wilayah. Portal Anda hanya dapat berisi REST APIs yang berada di Wilayah yang sama tempat Anda membuat portal.
-
Anda hanya dapat menggunakan Konsol Manajemen AWS, AWS CLI, atau AWS SDKs untuk membuat dan berbagi portal Anda.
-
Anda hanya dapat mengontrol akses ke portal Anda menggunakan kumpulan pengguna Amazon Cognito. Konsumen portal Anda dapat masuk langsung melalui kumpulan pengguna, atau mereka dapat bergabung melalui penyedia identitas pihak ketiga (iDP). Jika Anda menggunakan kumpulan pengguna Amazon Cognito, Anda tidak dapat menyetel rahasia klien untuk kumpulan pengguna Anda. Untuk informasi selengkapnya, lihat kumpulan pengguna Amazon Cognito.
