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