使用 Drupal 7 建構入口網站

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

越來越多的開發人員入口網站具備社交發布功能,以便與開發人員社群進行通訊。包括傳遞 API 說明文件和使用條款等靜態內容,以及社群提供的內容 (例如網誌和論壇)。

API 供應商必須公開自己的 API、向開發人員介紹 API、申請開發人員及允許開發人員註冊應用程式。將 API 公開給開發人員只是建立動態社群的一部分。此外,您也必須設法讓開發人員社群能夠提供意見回饋、提出支援和功能要求,以及提交自己的內容供其他開發人員存取。

Apigee Edge 為您提供開發人員服務入口網站,可用於建構及發布自訂網站,為您的開發社群提供上述所有服務。所有 Edge 客戶都能在雲端或地端部署環境中建立自己的開發人員入口網站。

以下影片介紹 Apigee Developer Services 入口網站。

下圖顯示預設開發人員入口網站的首頁:

預設開發人員入口網站首頁

開發人員入口網站基本上是一套以開放原始碼 Drupal (http://www.drupal.org) 專案為基礎的內容管理系統 (CMS)。Drupal 以模組的形式提供核心功能組合,可讓您輕鬆建構內容以及管理網站。

開發人員入口網站不僅可讓您建立 API 說明文件、支援網誌功能,還能提供討論串式論壇。您也可以根據自己的特定需求自訂開發人員入口網站。自訂可讓您修改入口網站的外觀,以及開發人員與入口網站互動的方式。

你可以使用 Drupal 選單執行大多數的自訂作業。如果您以具備管理員權限的使用者登入入口網站,Dupal 選單會顯示在每個入口網站頁面頂端:

登入後,Duupal 選單會顯示在入口網站頂端。

管理控制了以下程序:開發人員要求存取入口網站、開發人員如何註冊可存取 API 的應用程式、指派與 API 相關的特定角色和權限,以及撤銷開發人員對 API 存取權的時機。

您也可以透過開發人員入口網站設定及控管營利狀態。啟用營利功能後,開發人員就能透過開發人員入口網站自行存取帳單和報表、目錄和方案,以及營利專屬設定。

入口網站使用者類型

下圖顯示兩種入口網站使用者:

入口網站使用者分為兩種:開發人員和團隊。下方將顯示可執行任務的詳細資料。

  • 開發人員是由使用您的 API 建構應用程式的使用者組成社群。應用程式開發人員可透過入口網站瞭解 API,透過 SmartDocs 在入口網站上註冊帳戶、註冊使用您 API 的應用程式、與開發人員社群互動,以及在資訊主頁上查看應用程式使用情況的統計資訊。
  • API 團隊是建立入口網站內容、向應用程式開發人員提供 API 文件、提供 API 說明文件,以及為開發人員註冊應用程式及取得 API 金鑰的機制。API 團隊會執行開發人員入口網站的基本設定,以便執行下列操作:
    • 設定 API 金鑰的自動或手動要求
    • 維護 API 說明文件、論壇和網誌,並視需要修改所有變更
    • 處理使用者留言和論壇管理
    • 強制執行角色型存取權控管 (RBAC) 機制,控管入口網站的功能存取權。舉例來說,管理員可以啟用控制選項,讓已註冊的使用者建立論壇貼文或使用測試控制台
    • 自訂傳送給管理員和開發人員的電子郵件通知,方便他們建立及核准使用者
    • 自訂網路表單,例如「與我們聯絡」網頁

上圖中未顯示使用第三種入口網站使用者 - API 產品管理員。API 產品管理員負責定義 API 團隊建構入口網站的方式,包括:

  • 定義將 API 封裝至產品的方式
  • 定義應用程式核准規則
  • 如果入口網站已啟用營利功能,請定義 API 產品的定價和計費方案。如要進一步瞭解營利,請參閱「營利總覽」一文。

自訂開發人員入口網站

API 供應商應思考如何根據 API 自訂開發人員入口網站,並為開發人員社群提供使用 API 的必要資訊。自訂入口網站的一些注意事項包括:

  • 輕鬆存取 API
  • 說明文件,例如使用指南和參考文件
  • 社群提供的內容,例如網誌和論壇
  • 程式碼範例
  • 簡單的註冊程序,即可快速核准新開發人員、應用程式和 API
  • 管理權限和憑證
  • 分層存取權控管
  • 擁有符合貴機構需求的外觀和風格

入口網站具備預先定義的基本設定。舉例來說,在立即可用的入口網站上,入口網站設為允許所有人註冊為開發人員,但每個註冊都必須經過管理員核准,開發人員才能登入入口網站。註冊通過核准後,開發人員就能註冊應用程式來要求 API 金鑰,並透過入口網站存取 API 資源。

預設註冊流程的步驟如下:

  1. 開發人員透過開發人員入口網站註冊。做為回應,入口網站會傳送電子郵件給管理員來核准帳戶。
  2. 管理員核准帳戶後,系統會傳送電子郵件給開發人員,通知對方現在可以登入。
  3. 開發人員註冊應用程式後,會選取應用程式使用的 API 產品。為回應,入口網站會指派一組專屬 API 金鑰給應用程式。
  4. 開發人員向您的 API 傳送要求時,會傳遞 API 金鑰。

立即可用的自訂功能。舉例來說,您可以覆寫預設註冊和授權配置,讓新開發人員在註冊後自動核准並登入。或者,您也可以要求開發人員先接受一組條款及細則,他們才能首次登入。

您也能完全掌控開發人員入口網站顯示的內容。開發人員入口網站除了提供 API 說明文件、網誌文章和論壇討論等範例內容,您可以自行提供內容,並自訂每種內容類型的外觀。

詳情請參閱「自訂外觀」。

管理開發人員入口網站

開發人員可透過開發人員入口網站存取並使用您的 API。管理員會執行帳戶管理工作,例如:

  • 自訂開發人員註冊程序,包括註冊欄位、內建的人機驗證 (Captcha) 功能,以及自動或手動核准
  • 新增或核准開發人員。根據預設,所有開發人員皆可透過開發人員入口網站註冊,但必須由管理員透過開發人員入口網站使用者介面進行註冊。管理員也可以直接在入口網站中建立開發人員。接著,入口網站會自動傳送電子郵件給開發人員,告知他們已為他們建立帳戶。
  • 修改開發人員帳戶。舉例來說,管理員可以將使用者的帳戶狀態從「有效」改為「已封鎖」,或變更開發人員的設定檔資訊 (例如公司名稱)。
  • 移除開發人員。管理員可以停用或刪除開發人員的帳戶。
  • 指派角色和權限:管理員可以將特定角色指派給開發人員帳戶。角色與各種權限相關聯,例如建立書籍或其他內容的權限。您也可以變更與角色相關聯的權限,或建立新角色。

詳情請參閱「新增及管理使用者帳戶」。

開發人員入口網站功能摘要

下表摘要列出開發人員入口網站功能:

功能 詳細說明
瀏覽器支援

詳情請參閱支援的軟體和支援的版本

使用者註冊

  • 手動或自動核准新的開發人員帳戶
  • OpenID 整合
  • Twitter、Google 和 GitHub 支援單一登入 (SSO) 服務
  • 人機驗證 (CAPTCHA)
  • 自訂欄位

使用者管理

  • 建立及編輯使用者
  • 指派角色

入口網站外觀

  • 按 CSS、圖片和 Drupal 模組自訂

內容與社群管理

  • 以開放原始碼 (Drupal) 為基礎的
  • 以範本為基礎的內容
  • 立即可用的 API 說明文件、網誌、論壇、常見問題
  • Del.icio.us、Digg、Twitter 的自動連結
  • 內容的修訂版本控制項
  • 網誌的標記、關鍵字和封存
  • 與 Google Analytics (分析) 整合
  • 可自訂內容的熱門程度條件
  • 管理員管理的論壇文章和留言
  • 根據自訂角色、已登入和匿名的使用者提供不同的存取權

權限

  • 角色型存取規則

API 金鑰管理

  • 內建應用程式註冊
  • 支援自動或手動 API 金鑰核准
  • 管理員可以撤銷金鑰

傳送電子郵件

  • 指定 SMTP 伺服器
  • 設定入口網站向開發人員傳送電子郵件的時間
  • 控管入口網站產生的電子郵件內容和格式

網誌

  • 建立、編輯及發布網誌文章
  • 依角色設定的權限,只允許特定使用者類型建立網誌

論壇

  • 建立討論串式開發人員論壇
  • 視需要建立其他論壇類別
  • 依角色進行管理

說明文件

  • 製作 API 說明文件
  • 常見問題
  • 範例
  • 教學課程

選單

  • 控制選單的外觀和內容

搜尋

  • 內建 Apache Solr 搜尋機制
  • 搜尋特定內容。例如「論壇」或「網誌」
  • 控管 Google 索引建立作業

連結檢查器

  • 檢查網頁是否有無效連結。
  • 控管連結檢查清單