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
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.
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.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-09-03 UTC."],[[["\u003cp\u003eThis page outlines best practices for building an engaging and effective developer portal using Apigee and Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eCreating user-friendly URLs, descriptive portal names, and intuitive navigation are crucial for enhancing searchability and user experience.\u003c/p\u003e\n"],["\u003cp\u003eEnabling interactive API documentation with live request and response capabilities allows users to quickly understand and test your APIs.\u003c/p\u003e\n"],["\u003cp\u003eIncorporating relevant content like tutorials and use case examples, that are based on various audience levels will improve the user experience.\u003c/p\u003e\n"],["\u003cp\u003eUtilizing social media and community features such as forums and blogs will help to build a stronger developer community.\u003c/p\u003e\n"]]],[],null,["# Best practices for building your portal\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\n\u003cbr /\u003e\n\nApigee recommends that you apply the best practices described in the following sections when building your portal.\n\nEngage your audience\n--------------------\n\nAdd content that engages your audience visually and compels them to want to learn more. Enable API consumers to explore a portion of your portal without logging in. Provide self-service registration so they can get up and running quickly to build apps using your APIs.\n\nLet users try your APIs\n-----------------------\n\nAuto-generate interactive API documentation from your OpenAPI Specifications to enable users to:\n\n- Learn about the API\n- Send a live request to the API\n- View a live response returned from the API\n\n For more information, see [Publishing your APIs](/apigee/docs/api-platform/publish/portal/publish-apis).\n\nAddress primary learning paths\n------------------------------\n\nProvide use case examples and tutorials that are relevant to your audience and based on their level of experience. Demonstrate by example, such as a simple curl command sequence, or step through a more elaborate procedure.\n| You can learn from your internal consumers. Perform usability tests with internal consumers and revise content based on their feedback.\n\nImplement search engine optimization (SEO)\n------------------------------------------\n\nEnsure your content is searchable. Invest in SEO that improves your ranking in search results and enable users to find your content.\n\nUse the following best practices when structuring your content. For more information and additional guidelines from Google, see the [Google Search Engine Optimization Starter Guide](http://static.googleusercontent.com/media/www.google.com/en//webmasters/docs/search-engine-optimization-starter-guide.pdf).\n\nBuild a developer community\n---------------------------\n\nEmploy social media to promote your API community through standard social channels, such as Facebook, Twitter, and so on. Publish blogs and forums that foster communication and interaction among the developers in your API community."]]
