您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info
身為 API 供應商,您已開發一組 API,可提供後端服務的存取權。接下來,您需要建構開發人員入口網站,讓應用程式開發人員執行以下操作:
- 瞭解您的資料和服務
- 查看完整說明文件 (包括用途範例、教學課程和參考資料文件),瞭解如何使用 API
- 使用自助式程序註冊,以便建構使用您 API 的應用程式
開發人員入口網站解決方案總覽
Apigee 支援多種開發人員入口網站解決方案,詳情請見下表,從簡單的總體解決方案到可完全自訂及擴充的解決方案都有。選擇解決方案時,請根據自訂需求和實作入口網站所需的時間和知識,權衡利弊。
解決方法 | 功能 | 是否由 Apigee 代管? | 支援 (需要已授權的訂閱方案) |
---|---|---|---|
Apigee 整合式入口網站 | 簡單的自助式入口網站開發作業。 (僅限 Apigee Edge Public Cloud 客戶) |
是 | Apigee 全年無休的支援服務 |
Drupal 10 入口網站 | 使用開放原始碼 Drupal 10 專案,開發可完全自訂的自助式入口網站。使用 Apigee Edge 模組與 Apigee 整合。 | 否 | Apigee 提供 24 小時全年無休的故障修復問題支援服務 |
自訂入口網站 | 使用 Apigee 平台 API 開發可完全自訂的自助式入口網站。 | 否 | Apigee 全天候支援 (僅限 Apigee 平台 API) |
選擇開發人員入口網站解決方案
如要決定要選擇哪個開發人員入口網站解決方案,請參考下方的決策樹狀圖,並查看開發人員入口網站功能比較。
如果您是 Apigee Edge for Public Cloud 客戶,且打算支援入口網站開發的常見用途 (例如標準註冊和應用程式建立流程),以及更注重樣式而非功能的變更,不妨考慮建構 Apigee 整合式入口網站。
目前,Apigee Edge for Private Cloud 和營利服務客戶只能使用以 Drupal 為基礎的入口網站。
開發人員入口網站功能比較
下表比較了 Apigee 整合式入口網站和以 Drupal 為基礎的開發人員入口網站的功能。
功能 | 整合式入口網站 | Drupal |
---|---|---|
使用 Markdown 開發入口網站內容 | ||
使用 HTML 開發入口網站內容 | ||
使用 OpenAPI 規格轉譯的 API 參考文件 | ||
OpenAPI 規範第 3 版支援 | ||
從 API 參考資料傳送即時要求 | ||
自訂主題 | ||
自訂選單 | ||
Google Analytics 等第三方代碼 | ||
自訂 JavaScript 程式碼 | ||
自訂網域名稱 | ||
已啟用 HTTPs | ||
帳戶建立條款及細則 | ||
行動裝置顯示最佳化 | ||
整合自訂指令碼和指令碼標記 | ||
SMTP 設定 | ||
電子郵件範本設定 | ||
人機驗證 (Captcha) 可防範垃圾內容 | ||
開發人員/消費者帳戶的角色和權限 | ||
聯合登入 | ||
內容管理 API | 使用 Drupal | |
營利 | 即將推出 | |
搜尋設定 | * | |
網誌和論壇 | ** | |
用於建立內容的頁面範本 | ||
入口網站上的應用程式分析 | ||
以規則為準的事件管理 | ||
可透過外掛程式模組擴充 | ||
自訂應用程式註冊流程 | ||
自訂開發人員註冊流程 | ||
入口網站記錄 | ||
連結檢查器 | ||
Microsoft Internet Explorer/Microsoft Edge 支援服務 | 僅限 Microsoft Edge | |
Apigee 支援 | 請參閱上表 | 請參閱上表 |
建構整合式入口網站
如果您是 Apigee Edge for Public Cloud 的客戶,可以在 Edge UI 中快速建立輕量級開發人員入口網站。前往 https://apigee.com/edge 登入,然後在 Edge UI 的側邊導覽列中依序選取「Publish」>「Portals」。如需完整詳細資料,請參閱「建構整合式入口網站」。
下圖顯示整合式入口網站的到達網頁。
建構以 Drupal 為基礎的入口網站
您可以使用 Drupal 入口網站開發工具,建構可完全自訂的開發人員入口網站。Drupal 提供豐富的功能,以及 Drupal 的所有 CMS 功能,並提供額外的 Apigee 開發 Drupal 模組。不過,導入以 Drupal 為基礎的入口網站需要花費更多時間和心力。
Apigee Edge 與下列 Drupal 版本相容:
版本 | 說明 |
---|---|
Drupal 10 | 提供可靠的客戶管理型開放原始碼企業級內容管理系統 (CMS)。 由於 Drupal 10 是開放原始碼,您可以擴充 Drupal 10 入口網站開發架構並貢獻內容,以及運用 Drupal 社群的知識。詳情請參閱「使用 Drupal 10 建構入口網站」。 |
使用 Apigee Edge API 建構自訂入口網站
您可以利用下表列出的 Apigee Edge API,自行建構完全客製化的入口網站。如需詳細資訊,請參閱:
類別 | Apigee API | 說明 |
Analytics | 統計資料 | 查看 API 的數據分析資料。 |
API 金鑰 | 應用程式金鑰:開發人員 | 管理用於授權應用程式使用 API 的 API 金鑰。 |
API 產品 | API 產品 | 管理發布至開發人員入口網站的 API 產品。 |
應用程式 | 應用程式 | 管理開發人員註冊用於使用 API 的應用程式。 |
開發人員 | 開發人員 | 管理在開發人員入口網站註冊的開發人員。 |
營利 | 營利 | 透過 API 營利。 |
使用 適用於 PHP 的 Apigee Edge 用戶端程式庫,簡化入口網站用戶端的整合作業。有了 SDK,您就能輕鬆編寫使用前述表格中 Apigee API 的 PHP 模組。如要進一步瞭解 PHP 適用的 Apigee API 用戶端程式庫,請參閱: