Praktik terbaik untuk membuat portal Anda

Anda sedang melihat dokumentasi Apigee Edge.
Lihat dokumentasi Apigee X.

Apigee merekomendasikan agar Anda menerapkan praktik terbaik yang dijelaskan di bagian berikut saat mem-build portal.

Libatkan audiens

Tambahkan konten yang berinteraksi dengan audiens Anda secara visual dan mendorong mereka untuk mempelajari lebih lanjut. Izinkan konsumen API menjelajahi bagian portal Anda tanpa login. Sediakan pendaftaran mandiri agar dapat memulai dan menjalankan aplikasi dengan cepat menggunakan API Anda.

Mengizinkan pengguna mencoba API Anda

Buat otomatis dokumentasi API interaktif 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 penggunaan yang relevan dengan audiens Anda dan berdasarkan tingkat pengalaman mereka. Demonstrasikan dengan contoh, seperti urutan perintah curl sederhana, atau ikuti prosedur yang lebih rumit.

Menerapkan pengoptimalan mesin telusur (SEO)

Pastikan konten Anda dapat ditelusuri. Berinvestasilah pada SEO yang meningkatkan peringkat situs Anda dalam 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 Google Search Engine.

Praktik Terbaik Deskripsi Manfaat
Membuat URL yang mudah digunakan Buat URL yang mudah dibaca dan dipahami pengguna. 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 meningkatkan peringkat penelusuran.
  • Biasanya, URL muncul dalam hasil penelusuran.
Berikan nama portal 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 lengkap atau sebagian dalam judul akan meningkatkan peringkat penelusuran.
  • Biasanya, konten judul halaman ditampilkan sebagai baris pertama hasil penelusuran.
Memudahkan navigasi situs Anda Tentukan struktur navigasi yang logis, seperti yang dijelaskan dalam Menyiapkan navigasi.
  • Mempertahankan orientasi pengguna.
  • Membantu pengguna menemukan konten yang mereka inginkan dengan cepat dan mudah.
Gunakan campuran frasa kata kunci yang baik di seluruh konten Sertakan kata kunci di konten Anda yang relevan dan masuk akal untuk dilakukan. 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 agar tidak memasukkan kata kunci, yaitu berlebihan menggunakan kata kunci dengan tujuan semata-mata untuk meningkatkan peringkat penelusuran. Hal ini dapat mengakibatkan situs Anda diberi sanksi oleh mesin telusur. Pengguna yang menelusuri konten akan cenderung mendapatkan klik 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.