Anda sedang melihat dokumentasi Apigee Edge.
Buka
dokumentasi Apigee X. info
Apigee merekomendasikan agar Anda menerapkan praktik terbaik yang dijelaskan di bagian berikut saat membangun portal.
Libatkan audiens
Tambahkan konten yang melibatkan audiens Anda secara visual dan mendorong mereka untuk ingin mempelajari lebih lanjut. Izinkan konsumen API menjelajahi sebagian portal Anda tanpa login. Sediakan pendaftaran layanan mandiri agar mereka dapat menyiapkan dan menjalankan dengan cepat untuk membangun aplikasi menggunakan API Anda.
Mengizinkan pengguna mencoba API Anda
Buat otomatis dokumentasi API interaktif dari Spesifikasi OpenAPI Anda untuk memungkinkan pengguna:
- 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 bagi audiens Anda dan berdasarkan tingkat pengalaman mereka. Demonstrasikan dengan contoh, seperti urutan perintah curl sederhana, atau langkah melalui prosedur yang lebih rumit.
Menerapkan pengoptimalan mesin telusur (SEO)
Pastikan konten Anda dapat ditelusuri. Berinvestasilah pada SEO yang dapat meningkatkan peringkat Anda dalam hasil penelusuran dan memungkinkan pengguna menemukan konten Anda.
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. |
|
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. |
|
Permudah navigasi situs Anda | Tentukan struktur navigasi yang logis, seperti yang dijelaskan dalam Menyiapkan navigasi. |
|
Gunakan campuran frasa kata kunci yang baik di seluruh konten | Sertakan kata kunci dalam konten Anda jika relevan dan hal itu wajar. Keterlihatan string kata kunci pada halaman dapat meningkatkan peringkat halaman dalam hasil penelusuran. Coba prediksi string kata kunci yang mungkin digunakan pengguna saat menelusuri konten Anda. Hati-hati untuk tidak menggunakan penjejalan kata kunci, yaitu menggunakan kata kunci secara berlebihan yang bertujuan 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
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 antar-developer di komunitas API Anda.