您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。
Apigee 建議您在建構入口網站時,套用下列各節所述的最佳做法。
與觀眾交流互動
加入可以吸引觀眾的內容,讓他們迫不及待想進一步瞭解。讓 API 消費者不必登入即可查看入口網站的部分內容。提供自助式註冊服務,方便 API 設定並開始執行應用程式。
讓使用者試用您的 API
從 OpenAPI 規格自動產生互動式 API 說明文件,讓使用者可以:
- 瞭解 API
- 傳送即時要求至 API
查看 API 傳回的即時回應
詳情請參閱「發布 API」。
解決主要學習路徑
請根據目標對象的體驗,提供相應的範例和教學課程。示範的例子是簡單的 curl 指令或更複雜的程序。
實作搜尋引擎最佳化 (SEO)
確保內容可供搜尋。投資搜尋引擎最佳化 (SEO) 做法可以改善搜尋結果的排名,讓使用者更容易找到您的內容。
建構內容時,請採用下列最佳做法。如需更多資訊和 Google 其他指南,請參閱 Google 搜尋引擎最佳化入門指南。
最佳做法 | 說明 | 優點 |
---|---|---|
建立容易使用的網址 | 建立簡單好記的網址。在入口網站中新增網頁時,你可以定義使用者容易瞭解的網頁網址,詳情請參閱「建立網頁」一節。 |
|
提供描述性的入口網站名稱 | 為入口網站定義不重複的描述性入口網站名稱,詳情請參閱「管理入口網站」一文。此內容會用來填入入口網站的 <title> 標記 (index )。 |
|
讓網站易於瀏覽 | 定義符合邏輯的導覽結構,如「設定導覽」一文所述。 |
|
在所有內容中使用各種關鍵字詞組 | 在有關聯性且合理的情況下,為內容加入關鍵字。改善網頁上的關鍵字字串,有助於提升網頁在搜尋結果中的排名。嘗試預測使用者搜尋內容時可能使用的關鍵字字串。請小心不要濫填關鍵字,也就是只為了改善搜尋排名而使用關鍵字。這可能會導致網站遭到搜尋引擎懲處。 | 搜尋內容的使用者較有可能取得相關命中。 |
建立開發人員社群
運用社群媒體,透過標準社群平台 (例如 Facebook、Twitter 等) 宣傳 API 社群。發布網誌和論壇,促進 API 社群開發人員之間的交流和互動。