Praktik terbaik untuk membuat portal Anda

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

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

Libatkan audiens Anda

Tambahkan konten yang memikat audiens secara visual dan dorong mereka untuk ingin mempelajari lebih lanjut. Memungkinkan konsumen API menjelajahi sebagian portal Anda tanpa login. Sediakan pendaftaran layanan mandiri agar mereka dapat menyiapkan dan menjalankan aplikasi dengan cepat untuk membangun aplikasi 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 real time ke API

  • Melihat respons langsung yang ditampilkan dari API

    Untuk informasi selengkapnya, lihat Memublikasikan API.

Memahami jalur pembelajaran utama

Berikan contoh kasus penggunaan dan tutorial yang relevan bagi audiens 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. Lakukan investasi pada SEO yang akan meningkatkan peringkat Anda di hasil penelusuran dan memungkinkan pengguna menemukan konten Anda.

Pengoptimalan mesin telusur

Gunakan praktik terbaik berikut saat menyusun 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 akan meningkatkan peringkat penelusuran.
  • Biasanya, URL muncul di 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) pada portal Anda.
  • Pencocokan kata kunci penuh atau sebagian dalam judul akan meningkatkan peringkat penelusuran.
  • Biasanya, konten judul halaman Anda ditampilkan sebagai baris pertama hasil penelusuran.
Permudah navigasi situs Anda Tentukan struktur navigasi yang logis, seperti yang dijelaskan dalam Menyiapkan navigasi.
  • Menjaga berorientasi pada pengguna.
  • Membantu pengguna menemukan konten yang mereka inginkan dengan cepat dan mudah.
Gunakan kombinasi frasa kata kunci yang baik di seluruh konten Sertakan kata kunci dalam konten Anda jika relevan dan hal itu masuk akal. Keterlihatan string kata kunci di halaman Anda dapat meningkatkan peringkat halaman dalam hasil penelusuran. Coba prediksi string kata kunci yang mungkin digunakan pengguna saat menelusuri konten Anda. Berhati-hatilah untuk tidak menggunakan hal kata kunci, yaitu menggunakan kata kunci secara berlebihan yang hanya bertujuan untuk meningkatkan peringkat penelusuran. Ini bisa mengakibatkan situs Anda dihukum oleh mesin telusur. Pengguna yang menelusuri konten akan lebih cenderung mendapatkan klik 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 para developer di komunitas API Anda.