您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊
您可以使用 Drupal 的「Basic Page」內容類型在您的 API 中新增說明文件 (例如使用指南和 API 參考資料文件)，並納入影片、螢幕側錄或程式碼下載等內容。
「說明文件」頁面會根據各種類別整理出一些初步項目，例如「入門指南」和「教學課程」。頁面是編輯起點的起點。如此一來，您就可以新增自己的內容項目，並按您想要的方式整理這些項目。
新增說明文件首頁
根據預設，說明文件首頁位於開發人員入口網站的 <siteURL>/documentation。開發人員入口網站的預設首頁，會在首頁頂端的方塊中提供這個頁面的連結：
您也可以在開發人員入口網站選單的主選單中新增這個頁面的連結連結。
不過，根據預設，「說明文件」首頁不會存在，因此您必須使用正確的網址在開發人員入口網站上建立新頁面。
如何在開發人員入口網站中新增說明文件首頁：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「內容」>「新增內容」>「基本頁面」。
- 輸入文件標題 (例如「說明文件首頁」) 和第一頁的內容。
- 按一下「編輯摘要」以新增摘要。
- 按一下「Body」部分下方的「Menu」設定項目。
- 選取「提供選單連結」，新增連結標題，然後在父項項目中選取「<主選單>」。
這項操作會新增「說明文件」首頁的主選單連結。 - 按一下「內文」區段下方的「網址路徑設定」項目。
- 取消選取「Generate auto URLAlias」，然後將網址別名設為說明文件。
根據預設，網頁網址是 <siteURL>/content/pageName。您可以設定網址別名，藉此設定網頁的明確網址 (在本範例中為 <siteURL>/documentation)。 - 儲存網頁。
現在，選單列中應該會顯示相關頁面連結，首頁方塊中的連結應該可以正常運作。
管理員可以看到「查看」和「編輯」等內容管理按鈕。 非管理員則看不到。
在說明文件中新增子頁面
當您在說明文件中新增子頁面時：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「內容」>「新增內容」>「基本頁面」。
- 輸入網頁標題和內容。
- 按一下「編輯摘要」以新增摘要。
- 按一下「Body」部分下方的「Menu」設定項目。
- 選取「提供選單連結」，然後新增說明文件首頁選單項目。
系統隨即會將目前的頁面新增為說明文件首頁主選單的子項。 - 您現在應該會在「說明文件」首頁選單中看到相關頁面連結。
編輯說明文件頁面
如何編輯頁面：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 前往開發人員入口網站的頁面。
您也可以按一下 Drupal 管理選單中的「內容」，列出所有頁面並選取其中一個頁面。 - 選取頁面上的「編輯」分頁標籤。
- 在「內文」區段下方的「文字格式」下拉式選單中選取「完整 HTML」或「經過篩選的 HTML」，開啟視覺編輯器。
你應該會看到編輯器中的頁面內容。 - 視需要編輯頁面。
- 按一下「儲存」。
顯示任何說明文件頁面
如何顯示文件內容：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 選取 Drupal 管理選單中的「內容」。
- 選取你要查看的文件。
排列網頁順序
你可以在「說明文件」首頁選單中變更頁面的順序和巢狀層級。
如何在「說明文件」首頁選單中重新排列頁面：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「Structure」>「Menus」>「Main menu」。
- 選單中每個項目的名稱左側都會顯示圖示，如未看到圖示，請按一下「隱藏列粗細」。
- 如要移動項目，請按一下並拖曳圖示，將其移至新的位置。
拖曳含有子項項目的項目也會移動子項。
- 按一下「Save Configuration」。
編輯頁尾頁面
入口網站的頁尾包含 Twitter、Facebook 和 LinkedIn 的三個社群媒體圖示，以及含有下列網址的連結：
- 網址隱私權政策：<siteURL>/privacy-policy
- 網址條款與使用方式：<siteURL>/terms-use
- 以下網址的聯絡頁面：<siteURL>/contact-us
編輯這些網頁，自行新增內容。
如果這些網頁不存在，請按照下列步驟建立網頁：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「內容」>「新增內容」>「基本頁面」。
- 輸入文件標題 (例如「隱私權政策」) 和頁面內容。
- 按一下「編輯摘要」以新增摘要。
- 按一下「內文」區段下方的「網址路徑設定」項目。
- 選取「Generate auto URLAlias」，然後將網址別名設為隱私權政策。
根據預設，網頁網址是 <siteURL>/content/pageName。設定網址別名時，便會將網頁的明確網址 (在本範例中為 <siteURL>/privacy-policy) 進行設定。 - 儲存網頁。
- 針對「條款與使用」與「聯絡」頁面重複此程序。
如要在開發人員入口網站中編輯頁尾頁面的內容 (例如《隱私權政策》、《使用條款》或「與我們聯絡」頁面)，請按照下列步驟操作：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 按一下頁尾的連結，即可前往該網頁。例如，按一下「隱私權政策」連結。
- 按一下頁面中的「編輯」分頁標籤，開啟編輯器。
- 視需要變更《隱私權政策》頁面的內容。
- 點按「儲存」。
- 針對「條款與使用」與「聯絡」頁面重複此程序。
如要在開發人員入口網站中編輯 Twitter、Facebook 和 LinkedIn 等社群媒體圖示，請按照下列步驟操作：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「結構」>「區塊」。
- 向下捲動「封鎖」頁面，直到看見「全網站預設頁尾」區塊。
- 選取與全網站預設頁尾區塊相對應的「設定」configure連結。
- 在「Custom Content」(自訂內容) 區域中，在社交圖示上按一下滑鼠右鍵，然後在彈出式選單中選取「Edit Link」(編輯連結)。或是從「自訂內容」區域刪除圖示，即可移除該圖示。
- 選取「儲存區塊」即可儲存變更。
在入口網站頁面中新增 JavaScript
您可以將 JavaScript 新增到任何入口網站頁面，加入 JavaScript 最簡單的方法就是編輯網頁，然後：
- 選取「完整 HTML」做為文字格式。
- 選取「來源」按鈕，即可編輯網頁的 HTML 原始碼。
- 將 JavaScript 新增到網頁中。舉例來說，如要在網頁載入時彈出快訊方塊，請加入以下程式碼：
<script language="JavaScript">
alert('Welcome to my page!');
</script>
使用 JavaScript 的注意事項：
- 如果要參照 JavaScript 檔案，請勿在節點的原始碼中執行，因為這樣會建立靜態連結。請改用 PHP 程式碼來建立動態連結。如此一來，如果 JavaScript 檔案的位置有所變更，您就不需要更新所有參照該檔案的入口網站頁面。
- 如要加入 JavaScript 檔案，請將該檔案新增至入口網站主題。或者，如果該模組屬於 Drupal 模組，則請將其新增至模組。
- 您也可以使用 Drupal drupal_add_js 函式，在 Drupal 中新增 JavaScript。詳情請參閱 https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7。
檢查是否有無效連結
建議您檢查內容是否有無效連結。根據預設，開發人員入口網站會設定為檢查各種類型的網頁是否有無效連結。舉例來說，系統會在基本網頁、文章、網誌文章和論壇主題中檢查連結。
如何在連結檢查中新增或移除網頁類型：
- 在 Drupal 管理選單中選取「Modules」，並確認「Link Checker」模組已啟用。
- 在 Drupal 管理選單中，依序選取「Configuration」>「內容編寫」>「連結檢查工具」。
- 設定您要掃描無效連結的內容類型。
設定搜尋功能
開發人員入口網站提供 Apache Solr 實作的內建搜尋引擎，使用 Apache Lucene 搜尋程式庫。這是網站本身的搜尋引擎，使用者可透過所有入口網站頁面右上角的搜尋框來存取。
Google 等外部搜尋引擎也可以為您的入口網站建立索引。開發人員入口網站可讓您控管外部搜尋引擎能否為您的入口網站建立索引。
設定 Apache Solr
您可以設定 Apache Solr 來控管要建立索引的內容類型、強制建立索引，以及執行其他設定工作。
如何設定 Apache Solr：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中，依序選取「Configuration」>「Search and metadata」>「Apache Solr search」。
- 請使用這個頁面設定 Apache Solr。
停用 Google 索引功能
另一個好方法則是將內容編入索引，讓搜尋引擎檢索。根據預設，Google 索引器會將您的內容編入索引。不過，您也可以選擇停用 Google 索引功能。如果您的開發人員入口網站尚未做好公開使用準備，而您不想讓內容公開供大眾搜尋，建議您採用這種做法。
如何停用 Google 索引功能：
- 以具備管理員或內容建立權限的使用者登入入口網站。
- 在 Drupal 管理選單中選取「Modules」。
- 啟用「中繼標記」模組。
- 按一下「儲存設定」。
- 在 Drupal 管理選單中，依序選取「Configuration」>「Search and metadata」>「Metatag」。
- 針對「Global type」(全域類型) 選取「Override」 作業。
- 按一下「進階」部分即可開啟。
- 勾選「禁止搜尋引擎為這個網頁建立索引」核取方塊。
- 點按「儲存」。
請注意，「全域」頁面的「進階」部分有其他搜尋引擎相關選項，舉例來說，您可以勾選核取方塊，防止搜尋引擎前往網頁上的連結。視情況勾選一或多個核取方塊。
瞭解註冊應用程式的方式
說明文件必須附上開發人員透過開發人員入口網站註冊應用程式的操作說明。您可以從下列操作說明著手，以及如何透過預設的開發人員入口網站註冊應用程式。
如要設定開發人員在入口網站上註冊應用程式的方式，請參閱「設定應用程式註冊」一文。如果您修改了應用程式註冊程序，請據此修改下方的範例說明。
如何透過預設的開發人員入口網站註冊應用程式：
- 在登入選單中，選取使用者名稱下方的「我的應用程式」。
- 按一下「新增 (+)」應用程式圖示。
- 在「新增應用程式」頁面中輸入適當的值：
應用程式名稱 為您的應用程式提供專屬的應用程式名稱。 回呼網址 視需要提供 OAuth 呼叫應傳回的回呼網址。
根據預設，即使您的 API 並未使用 OAuth，這個值依然是必要值。如果 API 未使用 OAuth，請輸入虛擬值，例如 my.site.com。
產品 選取一或多項 API 產品。. - 按一下「建立應用程式」即可註冊應用程式，並產生該應用程式的 API 金鑰。