發布總覽

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

「發布」是指讓應用程式開發人員能夠使用您的 API 的過程。

影片:下列影片提供 API 發布功能的概略介紹。

發布 API 涵蓋下列工作,如本主題所述:

  1. 在 Edge 中建立封裝 API 的 API 產品。
  2. 在 Edge 上註冊應用程式開發人員。
  3. 在 Edge 上註冊開發人員應用程式。
  4. 為您的 API 提供說明文件和社群支援。

工作 1:在 Edge 中建立 API 產品

發布第一項工作是建立 API 產品。API 產品是一組 API 資源,為應用程式開發人員提供使用。使用 Edge Management API 或 UI 建立 API 產品。(如要進一步瞭解 API 產品,請參閱「什麼是 API 產品?」一文)。

由左至右的順序圖表,其中顯示開發人員、應用程式、API 和後端服務。畫面上會醒目顯示 API 圖示和資源。虛線由開發人員指向開發人員建構的應用程式圖示。在應用程式箭頭之間加上箭頭,顯示指向 API 圖示的要求和回應流程,並在要求上方顯示應用程式金鑰。畫面上會醒目顯示 API 圖示和資源。API 圖示下方有兩組資源路徑,分為兩項 API 產品:位置產品和媒體產品。位置產品具備 /countries、/cities 和 /languages 的資源,而媒體產品則提供 /books、/雜誌和 /movies 的資源。API 右側是 API 呼叫的後端資源,包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

在本圖中,API 是由兩項產品組成,每項產品都包含三項 API 資源。

API 供應商應負責建構 API 和 API 產品,以便處理存取權控管、使用限制和任何其他業務需求。舉例來說,你可以:

  • 發布免費的 API 產品,允許他人讀取其 API 資源。
  • 以較低的價格發布第二個 API 產品,允許讀取/寫入與免費版相同的 API 資源,但存取權設有限制,例如每日 1, 000 次要求。
  • 發布第三個 API 產品時,價格較高,這樣可以讀取/寫入相同的 API 資源,但存取權上限較高。

請特別注意,Edge 可讓您根據 API 的業務需求靈活建立 API 產品。

如要進一步瞭解如何建立 API 產品,請參閱「建立 API 產品」一文。

工作 2:在 Edge 上註冊應用程式開發人員

開發人員建立會使用您的 API 的應用程式。應用程式開發人員在 Apigee Edge 上註冊後,才能註冊應用程式。他們註冊應用程式時,會收到一組 API 金鑰,該金鑰可讓應用程式存取 API。

透過應用程式註冊流程,您可以控管哪些使用者有權存取您的 API。您可以隨時刪除一名應用程式開發人員,導致與該開發人員相關聯的所有 API 金鑰失效,進而拒絕該開發人員存取您的 API。

由左至右的順序圖表,其中顯示開發人員、應用程式、API 和後端服務。開發人員圖示以醒目方式顯示。虛線由醒目顯示的開發人員指向開發人員建構的應用程式圖示。在應用程式箭頭之間加上箭頭,顯示指向 API 圖示的要求和回應流程,並在要求上方顯示應用程式金鑰。API 圖示下方有兩組資源路徑,分為兩項 API 產品:位置產品和媒體產品。位置產品具備 /countries、/cities 和 /languages 的資源,而媒體產品則提供 /books、/雜誌和 /movies 的資源。API 右側是 API 呼叫的後端資源,包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

身為 API 供應商,您可以決定如何註冊開發人員。舉例來說,您可以採用手動註冊程序,要求潛在開發人員與貴機構聯絡以註冊。潛在開發人員必須提供所有必要資訊,例如電子郵件地址、姓名和公司名稱。如果您核准開發人員的要求,可以透過 Edge 管理 UI 手動註冊開發人員。詳情請參閱「管理應用程式開發人員」一文。

Apigee 也提供您可用於自動化開發人員註冊流程的工具。例如:

  • 使用 Apigee Edge Management API,將註冊功能整合至現有網站。Edge Management API 是一個 REST API,可用於執行開發人員註冊程序的所有層面。詳情請參閱「使用 Edge Management API 發布 API」。
  • 透過 Apigee Developer Services 入口網站為開發人員註冊。這個入口網站除了支援開發人員註冊之外,也提供許多其他功能支援您的 API。詳情請參閱「什麼是開發人員入口網站?」一文。

工作 3:在 Edge 上註冊開發人員應用程式

應用程式必須在 Edge 上註冊,才能存取您的 API。不過,只有註冊的開發人員可以在 Edge 上註冊應用程式。

由左至右的順序圖表,其中顯示開發人員、應用程式、API 和後端服務。應用程式、要求/回應和 API 金鑰箭頭會醒目顯示。虛線由開發人員指向開發人員建構的應用程式圖示。在應用程式箭頭之間加上箭頭,顯示指向 API 圖示的要求和回應流程,並在要求上方顯示應用程式金鑰。畫面上會醒目顯示 API 圖示和資源。API 圖示下方有兩組資源路徑,分為兩項 API 產品:位置產品和媒體產品。位置產品具備 /countries、/cities 和 /languages 的資源,而媒體產品則提供 /books、/雜誌和 /movies 的資源。API 右側是 API 呼叫的後端資源,包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

開發人員在註冊應用程式時,會選取一或多項 API 產品。舉例來說,您可以發布多個適用於不同服務和定價方案的 API 產品。接著,應用程式開發人員可以從可用的 API 產品清單中挑選所需 API 產品。

為回應在 Edge 上註冊應用程式,Edge 會為應用程式指派專屬 API 金鑰。應用程式必須在每個 API 資源要求中傳遞該 API 金鑰。金鑰也會經過驗證,如果有效,系統便會核准要求。服務供應商可以隨時撤銷金鑰,讓應用程式再也無法存取您的 API。

API 供應商可以決定要註冊應用程式的方式。您可以採取以下做法:

  • 採用手動程序,要求開發人員與貴機構聯絡,以註冊自己的應用程式。建議您透過電子郵件將 API 金鑰傳送給開發人員。
  • 使用 Edge Management API 將應用程式註冊功能和金鑰提交功能整合至網站。
  • 如果是付費 Edge 帳戶,請使用已內建支援應用程式註冊和 API 金鑰傳送功能的 Apigee Developer Services 入口網站。

詳情請參閱「註冊應用程式及管理 API 金鑰」一文。

工作 4:記錄 API

發布 API 產品時,請務必提供說明文件和開發人員意見回饋機制。具有社交發布功能的開發人員入口網站越來越常使用,與開發社群進行通訊。包括傳遞 API 說明文件和使用條款等靜態內容、動態社群提供的內容 (如網誌和論壇),以及客戶服務功能。

由左至右的順序圖表,其中顯示開發人員、應用程式、API 和後端服務。開發人員圖示以醒目方式顯示。開發人員下方有個方塊代表開發人員入口網站。這個入口網站含有 API 說明文件、範例、教學課程、API 參考資料和其他內容。入口網站中也有網誌、論壇和支援入口網站。虛線由醒目顯示的開發人員指向開發人員建構的應用程式圖示。在應用程式箭頭之間加上箭頭,顯示指向 API 圖示的要求和回應流程,並在要求上方顯示應用程式金鑰。API 圖示下方有兩組資源路徑,分為兩項 API 產品:位置產品和媒體產品。位置產品具備 /countries、/cities 和 /languages 的資源,而媒體產品則提供 /books、/雜誌和 /movies 的資源。API 右側是 API 呼叫的後端資源,包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

您可以自行建立網站來部署說明文件;如果您有付費 Edge 帳戶,可以使用 Apigee Developer Services 入口網站。入口網站內建支援說明文件、網誌、論壇和其他類型的內容,支援您的開發人員社群。

SmartDocs 可讓您在開發人員服務入口網站上記錄 API 的功能,使 API 說明文件具備完整的互動性。透過 SmartDocs 搭配互動式說明文件,入口網站使用者可以:

  • 瞭解 API
  • 將即時要求傳送至 API
  • 查看 API 傳回的即時回應

例如,下圖顯示使用 SmartDocs 在入口網站上記錄的 API。這個 API 可提供特定地點的天氣資訊:

「SmartDocs API 方法」主題主題,讓您點選主題中的按鈕以呼叫氣象 API。

開發人員輸入「w」查詢參數的值來指定位置,然後按一下「Send the request」按鈕查看即時要求和回應。只要在您的 API 建立互動式說明文件,入口網站使用者就能輕鬆學習、測試及評估您的 API。

Edge Management API 是 REST API,可讓您透過任何 HTTP 用戶端存取 API 服務。Apigee 會使用 SmartDocs 為 Edge Management API 建立互動式說明文件。 請參閱這裡的 API 說明文件。

詳情請參閱「使用 SmartDocs 記錄 API」。