Membuat produk portal di API Gateway - Amazon API Gateway
Pertimbangan-pertimbanganBuat produk portal

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Membuat produk portal di API Gateway

Prosedur berikut menunjukkan cara membuat produk portal. Portal adalah kumpulan produk portal. Setelah Anda membuat produk portal Anda, Anda membuat titik akhir REST produk dan halaman produk. Untuk mempelajari tentang produk portal, lihatProduk portal di API Gateway.

Pertimbangan-pertimbangan

Pertimbangan berikut dapat memengaruhi cara Anda membuat produk portal:

  • Produk portal Anda dapat berisi REST pribadi dan publik APIs. Private APIs tidak didukung untuk fungsi try it dan, sebagai hasilnya, memiliki perbedaan visual di portal Anda. Sebagai pemilik portal, Anda mungkin perlu memberikan dokumentasi untuk menjelaskan hal ini.

  • Jika Anda membuat produk portal menggunakan AWS CLI atau AWS SDKs, portal Anda tidak akan memiliki titik akhir produk atau halaman produk. Anda perlu menambahkan sumber daya ini menggunakan konsol AWS CLI atau. Untuk mempelajari cara membuat endpoint REST produk, lihatMembuat titik akhir REST produk di API Gateway. Untuk mempelajari cara membuat halaman produk, lihatMembuat halaman produk di API Gateway.

Buat produk portal

Prosedur berikut menunjukkan cara membuat produk portal.

Untuk membuat produk portal

  1. Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway.

  2. Di panel navigasi utama, pilih produk Portal.

  3. Pilih Buat produk.

  4. Untuk nama Produk, masukkan nama produk portal Anda.

  5. Untuk deskripsi Produk, masukkan deskripsi.

  6. Pilih Berikutnya.

  7. Untuk memilih titik akhir REST produk Anda, di bawah titik akhir API pilih API, lalu pilih tahapan.

  8. Untuk menambahkan titik akhir ke titik akhir REST produk Anda, pilih titik akhir API, lalu pilih Tambahkan ke produk.

    catatan

    Jangan memilih Berikutnya tanpa terlebih dahulu memilih Tambahkan ke produk.

    Produk portal

    Titik akhir API akan muncul di daftar titik akhir API Terpilih.

  9. Pilih Berikutnya.

  10. Tinjau pilihan Anda dan pilih Buat produk.

Setelah Anda membuat produk portal menggunakan konsol, semua halaman produk dan halaman titik akhir REST produk Anda adalah draf dan tidak akan muncul di portal. Agar halaman produk dan halaman akhir REST produk Anda terlihat oleh konsumen, Anda perlu menambahkan draf Anda ke bagian. Jika Anda membuat produk portal Anda menggunakan AWS CLI atau AWS SDKs, Anda menambahkan draf ke bagian dalam AWS CLI perintah. Terlepas dari bagaimana Anda menambahkan draf Anda ke bagian, Anda harus mempublikasikan portal yang menggunakan produk portal Anda agar dapat dilihat oleh konsumen.

Untuk menambahkan draf Anda ke bagian halaman

  1. Draf Anda tercantum di tab Dokumentasi. Ada halaman dokumentasi Draf untuk halaman produk Anda dan halaman referensi Draft API untuk halaman titik akhir REST produk Anda. Pilih halaman referensi Draft API.

  2. Pilih halaman referensi API draf.

    Jika Anda tidak memiliki titik akhir REST produk, Anda tidak akan memiliki halaman referensi API draf apa pun. Untuk mempelajari cara membuat endpoint REST produk, lihatMembuat titik akhir REST produk di API Gateway.

  3. Pilih Edit halaman.

  4. Di halaman ini, Anda dapat menimpa bagian dokumentasi API yang ada atau menggunakan dokumentasi API Gateway. Agar konten halaman akhir REST produk Anda dapat dilihat oleh konsumen, di bawah nama Bagian, masukkan nama. Jika ini adalah /pets-GET titik akhir, nama halaman bisa Pets jadi.

  5. Pilih Simpan perubahan.

  6. Nama halaman baru yang Anda buat muncul di bagian halaman referensi API.

    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.