Praktik terbaik untuk membuat portal

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.

Berinteraksi dengan audiens

Tambahkan konten yang menarik perhatian audiens secara visual dan membuat mereka ingin mempelajari lebih lanjut. Memungkinkan konsumen API menjelajahi sebagian portal Anda tanpa login. Menyediakan pendaftaran layanan mandiri sehingga mereka dapat mulai menggunakan API Anda dengan cepat untuk membangun aplikasi.

Mengizinkan pengguna mencoba API Anda

Buat dokumentasi API interaktif secara otomatis dari Spesifikasi OpenAPI Anda untuk memungkinkan pengguna:

  • Mempelajari API
  • Mengirim permintaan langsung ke API

  • Melihat respons langsung yang ditampilkan dari API

    Untuk mengetahui 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. Tunjukkan dengan contoh, seperti urutan perintah curl sederhana, atau ikuti prosedur yang lebih rumit.

Menerapkan pengoptimalan mesin telusur (SEO)

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

Pengoptimalan mesin telusur

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

Praktik Terbaik Deskripsi Manfaat
Membuat URL yang mudah digunakan Buat URL yang mudah dipahami dan dapat dibaca manusia. Tentukan URL halaman yang mudah digunakan saat menambahkan halaman ke portal Anda, seperti yang dijelaskan dalam Membuat halaman.
  • Menyampaikan tujuan halaman dalam bentuk yang dapat dibaca manusia.
  • Pencocokan kata kunci lengkap 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 Anda, 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, isi judul halaman Anda ditampilkan sebagai baris pertama hasil penelusuran.
Membuat situs Anda mudah dijelajahi Tentukan struktur navigasi yang masuk akal, seperti yang dijelaskan dalam Menyiapkan navigasi.
  • Memastikan pengguna tetap berorientasi.
  • Membantu pengguna menemukan konten yang mereka inginkan dengan cepat dan mudah.
Gunakan campuran frasa kata kunci yang baik di seluruh konten Sertakan kata kunci dalam konten Anda jika relevan dan masuk akal. Keterlihatan string kata kunci di halaman Anda dapat meningkatkan peringkat halaman di hasil penelusuran. Coba prediksi string kata kunci yang mungkin digunakan pengguna saat menelusuri konten Anda. Berhati-hatilah agar tidak memasukkan terlalu banyak kata kunci, yaitu menggunakan kata kunci secara berlebihan hanya untuk meningkatkan peringkat penelusuran. Hal ini dapat menyebabkan situs Anda dikenai sanksi oleh mesin telusur. Pengguna yang menelusuri konten akan lebih mungkin mendapatkan hasil yang relevan.

Membangun komunitas developer

Gunakan media sosial untuk mempromosikan komunitas API Anda melalui saluran sosial standar, seperti Facebook, Twitter, dan sebagainya. Publikasikan blog dan forum yang mendorong komunikasi dan interaksi di antara developer dalam komunitas API Anda.