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

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

Membuat halaman produk di API Gateway

Halaman produk membantu konsumen produk Anda memahami dan menggunakan produk Anda. Dokumentasi berada di tingkat produk, jadi portal apa pun yang menyertakan produk Anda memiliki dokumentasi ini. API Gateway mendukung dua jenis halaman produk yang ditulis dalam GitHub Flavored Markdown:

Halaman Ikhtisar

Saat Anda membuat produk, API Gateway secara otomatis membuat halaman Ikhtisar untuk produk Anda berdasarkan informasi yang Anda berikan saat membuat produk. Halaman ini memiliki format tambahan yang tidak dapat diubah. Anda dapat memodifikasi teks atau menghapus halaman dari produk portal.

Halaman kustom

Halaman kustom adalah halaman yang ditulis dalam Markdown. Anda dapat menggunakan bagian ini untuk syarat dan ketentuan atau tutorial tentang cara menggunakan produk Anda. Anda dapat mengubah halaman kustom menjadi halaman ikhtisar. Saat Anda mengubah halaman kustom menjadi halaman ikhtisar, konten halaman diformat agar sesuai dengan halaman ikhtisar.

Pertimbangan-pertimbangan

Pertimbangan berikut dapat memengaruhi penggunaan halaman produk Anda:

  • Dokumentasi ini tidak berada di tingkat API dan tidak menyertakan metode, sumber daya, atau parameter permintaan apa pun. Untuk mempelajari cara memodifikasi dokumentasi di tingkat API untuk suatu produk, lihat. Memperbarui titik akhir REST produk di API Gateway

  • Anda tidak dapat langsung mengunggah .md file ke produk Anda.

  • Anda dapat mengubah urutan halaman produk dengan memodifikasi daftar halaman dalam urutan tampilan produk portal Anda. Untuk informasi selengkapnya, lihat Memperbarui produk portal di API Gateway.

  • Anda perlu mempublikasikan ulang portal apa pun yang menyertakan produk Anda agar perubahan dokumentasi diterapkan.

  • Jika Anda memiliki beberapa portal yang menggunakan produk portal yang sama, halaman produk sama di semua portal. Untuk memiliki titik akhir REST produk yang sama tetapi halaman produk yang berbeda, buat beberapa produk.

Buat halaman produk

Prosedur berikut menunjukkan cara membuat halaman produk.

Untuk membuat halaman produk

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

  2. Di panel navigasi utama, pilih produk Portal.

  3. Pilih produk.

  4. Di bawah Dokumentasi, pilih Buat halaman kustom.

  5. Untuk judul Halaman, masukkan judul halaman.

  6. Untuk Body, masukkan dokumentasi tambahan Anda menggunakan GitHub Flavored Markdown.

    Bagian Pratinjau menunjukkan bagaimana konten Anda muncul di portal. Gaya visual akhir mungkin berubah berdasarkan pengaturan portal Anda.

  7. Pilih Buat halaman produk.

  8. Halaman produk Anda sekarang menjadi draf. Pilih halaman dokumentasi draf, lalu pilih halaman produk Anda untuk menyelesaikan konten halaman.

  9. Pilih Edit halaman.

  10. Untuk nama Bagian, masukkan nama atau pilih bagian yang ada. Ketika Anda menambahkan halaman produk Anda ke bagian, konsumen dapat melihat konten Anda di portal yang dipublikasikan.

  11. 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.