本頁內容適用於 Apigee 和 Apigee Hybrid。
查看
Apigee Edge 說明文件。
Apigee 建議您在建構入口網站時,套用下列各節所述的最佳做法。
與觀眾互動
加入能吸引觀眾目光的內容,讓他們想進一步瞭解。讓 API 消費者不必登入,即可探索入口網站的部分內容。提供自助式註冊功能,讓他們能快速上手,使用您的 API 建構應用程式。
讓使用者試用您的 API
從 OpenAPI 規格自動產生互動式 API 說明文件,讓使用者能夠:
- 瞭解 API
- 傳送即時要求至 API
查看 API 傳回的即時回應
詳情請參閱「發布 API」。
解決主要學習路徑問題
根據目標對象的經驗程度,提供相關的使用案例和教學課程。請舉例說明,例如簡單的 curl 指令序列,或逐步說明更複雜的程序。
實作搜尋引擎最佳化 (SEO)
確保內容可供搜尋。投資搜尋引擎最佳化 (SEO),提升搜尋結果排名,讓使用者找到你的內容。
建構內容時,請遵循下列最佳做法。如需更多資訊和 Google 的其他指南,請參閱 Google 搜尋引擎最佳化入門指南。
最佳做法 | 說明 | 優點 |
---|---|---|
建立容易使用的網址 | 建立簡單易懂的網址。將網頁新增至入口網站時,請定義易於使用的網頁網址,如「建立網頁」一文所述。 |
|
提供描述性入口網站名稱 | 如「管理入口網站」一文所述,為入口網站定義不重複的描述性名稱。這項內容會用於填入入口網站首頁 (index ) 的 <title> 標記。 |
|
讓網站易於瀏覽 | 如「設定導覽」一文所述,定義合乎邏輯的導覽結構。 |
|
在內容中適當搭配使用關鍵字詞組 | 在內容中加入相關且有意義的關鍵字。網頁上關鍵字字串的顯著性越高,網頁在搜尋結果中的排名就越有機會提升。盡量預測使用者搜尋你的內容時可能會使用的關鍵字字串。請注意不要濫用關鍵字,也就是為了提升搜尋排名而過度使用關鍵字。這可能會導致搜尋引擎對您的網站處以懲罰。 | 搜尋內容的使用者更有可能找到相關結果。 |
建立開發人員社群
透過 Facebook、Twitter 等標準社群管道,運用社群媒體宣傳 API 社群。發布網誌和論壇,促進 API 社群中的開發人員交流互動。