Praktik terbaik untuk membuat portal

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

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

Libatkan audiens

Tambahkan konten yang menarik audiens secara visual dan mendorong mereka untuk ingin mempelajari lebih lanjut. Memungkinkan konsumen API menjelajahi sebagian portal Anda tanpa login. Berikan pendaftaran mandiri agar mereka dapat menyiapkan dan menjalankan aplikasi dengan cepat menggunakan API Anda.

Mengizinkan pengguna mencoba API Anda

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

  • Mempelajari API
  • Mengirim permintaan langsung ke API

  • Melihat respons langsung yang ditampilkan dari API

    Untuk informasi selengkapnya, lihat Memublikasikan API.

Mengatasi jalur pembelajaran utama

Berikan contoh kasus dan tutorial yang relevan dengan audiens Anda dan berdasarkan tingkat pengalaman mereka. Tunjukkan dengan contoh, seperti urutan perintah curl sederhana, atau langkah-langkah dalam prosedur yang lebih rumit.

Mengimplementasikan 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 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, seperti yang dijelaskan dalam Membuat halaman.
  • Menyampaikan tujuan halaman dalam bentuk yang dapat dibaca manusia.
  • Pencocokan kata kunci lengkap atau sebagian di URL halaman akan 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 di Mengelola portal. Konten ini digunakan untuk mengisi tag <title> untuk halaman beranda (index) portal Anda.
  • Pencocokan kata kunci lengkap atau sebagian dalam judul akan meningkatkan peringkat penelusuran.
  • Biasanya, konten judul halaman Anda ditampilkan sebagai baris pertama hasil penelusuran.
Buat situs Anda mudah dijelajahi Tentukan struktur navigasi yang masuk akal, seperti yang dijelaskan dalam Menyiapkan navigasi.
  • Menjaga orientasi pengguna.
  • Membantu pengguna menemukan konten yang mereka inginkan dengan cepat dan mudah.
Menggunakan campuran frasa kata kunci yang baik di seluruh konten Sertakan kata kunci dalam konten Anda jika relevan dan masuk akal untuk melakukannya. Kemunculan 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 melakukan penyimpangan kata kunci, yaitu, menggunakan kata kunci secara berlebihan hanya untuk meningkatkan peringkat penelusuran. Hal ini dapat menyebabkan situs Anda dihukum oleh mesin telusur. Pengguna yang menelusuri konten akan lebih cenderung mendapatkan hit yang relevan.

Membangun komunitas developer

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