Praktik terbaik untuk membuat portal Anda

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat Dokumentasi Apigee Edge.

Apigee merekomendasikan agar Anda menerapkan praktik terbaik yang dijelaskan di bagian berikut saat membangun portal.

Libatkan audiens Anda

Tambahkan konten yang menarik audiens Anda secara visual dan mendorong mereka untuk ingin mempelajari lebih lanjut. Izinkan konsumen API menjelajahi bagian portal Anda tanpa login. Sediakan pendaftaran layanan mandiri sehingga pengguna dapat menyiapkan dan menjalankannya dengan cepat untuk membangun aplikasi menggunakan API Anda.

Mengizinkan pengguna mencoba API Anda

Buat secara otomatis dokumentasi API interaktif dari Spesifikasi OpenAPI agar pengguna dapat:

• Mempelajari API
• Mengirim permintaan langsung ke API

• Melihat respons langsung yang ditampilkan dari API

  Untuk informasi selengkapnya, lihat Memublikasikan API.

Menangani jalur pembelajaran utama

Berikan contoh kasus penggunaan dan tutorial yang relevan dengan audiens Anda dan berdasarkan tingkat pengalaman mereka. Peragakan dengan contoh, seperti urutan perintah curl sederhana, atau ikuti prosedur yang lebih rumit.

Anda dapat belajar dari konsumen internal. Lakukan uji kegunaan dengan konsumen internal dan revisi konten berdasarkan masukan mereka.

Menerapkan pengoptimalan mesin telusur (SEO)

Memastikan konten Anda dapat ditelusuri. Berinvestasilah pada SEO yang dapat meningkatkan peringkat Anda di hasil penelusuran dan memungkinkan pengguna menemukan konten Anda.

Gunakan praktik terbaik berikut saat menyusun struktur konten. Untuk informasi selengkapnya dan panduan tambahan dari Google, lihat Panduan Memulai Pengoptimalan Mesin Telusur Google.

Praktik Terbaik	Deskripsi	Manfaat
Buat URL yang mudah digunakan	Buat URL yang mudah dipahami dan dapat dibaca manusia. Tentukan URL halaman yang mudah digunakan saat menambahkan halaman ke portal, seperti yang dijelaskan dalam Membuat halaman.	Menyampaikan tujuan halaman dalam bentuk yang dapat dibaca manusia. Pencocokan kata kunci penuh atau sebagian di URL halaman meningkatkan peringkat penelusuran. Biasanya, URL muncul di hasil penelusuran.
Berikan nama portal yang deskriptif	Tentukan nama portal yang unik dan deskriptif untuk portal, seperti yang dijelaskan dalam Mengelola portal Anda. Konten ini digunakan untuk mengisi tag <title> untuk halaman beranda (index) portal Anda.	Pencocokan kata kunci penuh atau sebagian dalam judul meningkatkan peringkat penelusuran. Biasanya, konten judul halaman ditampilkan sebagai baris pertama hasil penelusuran.
Permudah navigasi situs Anda	Tentukan struktur navigasi yang logis, seperti yang dijelaskan dalam Menyiapkan navigasi.	Menjaga agar pengguna tetap berorientasi. Membantu pengguna menemukan konten yang mereka inginkan dengan cepat dan mudah.
Gunakan campuran frasa kata kunci yang tepat di seluruh konten	Sertakan kata kunci dalam konten Anda jika relevan dan masuk akal. Keterlihatan string kata kunci pada halaman dapat meningkatkan peringkat halaman di hasil penelusuran. Coba prediksi string kata kunci yang mungkin digunakan pengguna saat menelusuri konten Anda. Berhati-hatilah untuk tidak menggunakan penjejalan kata kunci yang berarti penggunaan kata kunci yang berlebihan dengan tujuan meningkatkan peringkat penelusuran. Hal ini dapat mengakibatkan situs Anda diberi sanksi oleh mesin telusur.	Pengguna yang menelusuri konten akan lebih cenderung mendapatkan hit yang relevan.

Membangun komunitas developer

Manfaatkan media sosial untuk mempromosikan komunitas API Anda melalui saluran media sosial standar, seperti Facebook, Twitter, dan sebagainya. Publikasikan blog dan forum yang memupuk komunikasi dan interaksi antar-developer di komunitas API Anda.