Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Membuat titik akhir REST produk di API Gateway
Titik akhir REST produk adalah titik akses ke produk portal Anda. Setiap titik akhir terdiri dari jalur dan metode REST API dan tahap penerapannya. Titik akhir mencakup dokumentasi apa pun yang telah Anda tetapkan untuk REST API Anda, atau dapat diperbarui dengan dokumentasi khusus. Saat membuat endpoint REST produk, Anda mengonfigurasi pengaturan berikut:
-
Nama operasi titik akhir REST produk. Jika REST API Anda memiliki jalur dan metode
GET /pets, di portal, namanya adalah/pets. Dengan menggunakan nama operasi, Anda dapat mengubah nama titik akhir REST produk menjadiPet summaries. Ini tidak memengaruhi API Anda yang ada. -
Fungsi try it untuk titik akhir produk Anda. Ini memungkinkan konsumen API mencoba Anda APIs di portal Anda. Jika Anda membuat titik akhir produk untuk API pribadi, fungsi try it akan disetel ke
UNAVAILABLE. Untuk informasi selengkapnya, lihat Aktifkan coba untuk titik akhir REST produk API Gateway di portal Anda. -
Jika saat ini Anda memiliki bagian dokumentasi yang ditentukan untuk REST API, Anda dapat mengimpor dokumentasi atau mengganti dokumentasi yang ada dan membuat dokumentasi tingkat produk baru menggunakan GitHub Flavored Markdown.
Setiap penggantian dokumentasi tidak disebarkan kembali ke bagian dokumentasi API Gateway API Anda. Jika Anda mengimpor bagian dokumentasi saat ini, API Gateway menyinkronkan perubahan di seluruh API Anda ke titik akhir REST produk Anda.
Buat titik akhir REST produk
Prosedur berikut menunjukkan cara menambahkan titik akhir REST produk ke produk portal yang ada. Untuk mempelajari cara membuat produk portal dan titik akhir REST produk bersama-sama, lihatMembuat produk portal di API Gateway.
Untuk membuat endpoint REST produk untuk portal produk
Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway
. Di panel navigasi utama, pilih produk Portal.
Pilih produk portal.
Pilih tab Titik akhir terkait, lalu pilih Tambahkan titik akhir.
-
Untuk memilih titik akhir REST produk Anda, di bawah titik akhir API pilih API, lalu pilih tahapan.
Untuk menambahkan titik akhir ke titik akhir REST produk Anda, pilih titik akhir API, lalu pilih Tambahkan ke produk.
Titik akhir API akan muncul di daftar titik akhir API Terpilih.
Pilih Kirim.
-
Halaman akhir REST produk Anda sekarang menjadi draf. Pilih halaman referensi Draft API, lalu pilih halaman endpoint REST produk Anda untuk menyelesaikan konten halaman.
Pilih Edit halaman.
-
Untuk mengganti dokumentasi API Gateway yang ada, untuk sumber Dokumentasi, aktifkan Ganti dokumentasi dan lakukan hal berikut:
Untuk Menampilkan konten, pilih Buat penggantian.
Untuk nama Operasi, masukkan nama operasi baru.
Untuk badan Halaman, masukkan dokumentasi kustom Anda.
-
(Opsional) Untuk Endpoint, masukkan titik akhir kustom yang muncul di portal Anda.
-
Untuk memungkinkan pelanggan menjalankan API Anda di portal Anda, pilih fungsi Coba itu. Untuk informasi selengkapnya, lihat Aktifkan coba untuk titik akhir REST produk API Gateway di portal Anda.
-
Untuk nama Bagian, masukkan nama atau pilih bagian yang ada. Saat Anda menambahkan titik akhir REST produk Anda ke bagian, konsumen dapat melihat konten Anda di portal yang dipublikasikan.
Pilih Simpan perubahan.
Agar halaman baru dapat dilihat oleh konsumen, Anda masih perlu mempublikasikan ulang portal Anda. Lihat informasi yang lebih lengkap di Publikasikan portal di API Gateway.
