您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
Apigee 建議您在建構入口網站時,套用下列各節所述的最佳做法。
與觀眾交流互動
新增能吸引觀眾目光的內容,讓他們想要瞭解更多資訊。讓 API 使用者不必登入,即可探索入口網站的部分內容。提供自助式註冊服務,方便他們快速完成設定並開始使用 API 建構應用程式。
讓使用者試用您的 API
從 OpenAPI 規格自動產生互動式 API 說明文件,讓使用者可以:
- 瞭解 API
- 將即時要求傳送至 API
查看 API 傳回的即時回應
詳情請參閱「發布 API」。
因應主要學習路徑
提供與目標對象相關的使用案例和教學課程,並應根據他們的經驗程度進行調整。透過範例示範,例如簡單的 curl 指令序列,或逐步執行更複雜的程序。
實作搜尋引擎最佳化 (SEO)
確認你的內容可供搜尋。投資 SEO 以改善網站在搜尋結果中的排名,讓使用者更容易找到您的內容。
規劃內容時,請採用下列最佳做法。如需詳細資訊和 Google 提供的其他指南,請參閱 Google 搜尋引擎最佳化入門指南。
最佳做法 | 說明 | 優點 |
---|---|---|
建立容易使用的網址 | 建立簡單易懂且清楚易懂的網址。將網頁新增至入口網站時,請按照「建立頁面」一節的說明,定義容易理解的網頁網址。 |
|
提供描述性的入口網站名稱 | 按照「管理入口網站」一文的說明,為入口網站定義不重複且具描述性的入口網站名稱。這項內容會用於填入入口網站首頁 (index ) 的 <title> 標記。 |
|
讓網站易於瀏覽 | 定義合理的導覽結構,如設定導覽一文所述。 |
|
在內容中選用合適的關鍵字詞組 | 在內容中加入相關且適合使用的關鍵字。在網頁中加入適當的關鍵字字串,可提高網頁在搜尋結果中的排名。試著預測使用者搜尋您的內容時可能會使用的關鍵字字串。請小心不要在濫填關鍵字,也就是過度使用關鍵字,只為了提升搜尋排名。但搜尋引擎可能會因此對網站做出懲處。 | 使用者搜尋內容的使用者較有可能獲得相關命中。 |
打造開發人員社群
利用社群媒體,透過 Facebook、Twitter 等標準社群媒體管道宣傳 API 社群。發布網誌和論壇,促進 API 社群中開發人員的溝通交流及互動。