發布總覽

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

發布是指將 API 提供給應用程式開發人員使用。

影片：以下影片將概略介紹 API 發布作業。

發布 API 涉及本主題中所述的下列工作：

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

任務 1：在 Edge 上建立 API 產品

發布的第一項工作是建立 API 產品。API 產品是 API 資源的集合，可做為套件提供給應用程式開發人員使用。使用 Edge 管理 API 或 UI 建立 API 產品。(如要進一步瞭解 API 產品，請參閱「什麼是 API 產品？」)。

從左到右的循序圖，顯示開發人員、應用程式、API 和後端服務。API 圖示和資源已醒目顯示。虛線從開發人員指向開發人員建構的應用程式圖示。從應用程式和返回應用程式的箭頭，會顯示要求和回應流向 API 圖示，並在要求上方放置應用程式索引鍵。API 圖示和資源已醒目顯示。API 圖示下方有兩組資源路徑，分別歸類為兩個 API 產品：位置資訊產品和媒體產品。位置產品提供 /countries、/cities 和/或 /languages 的資源，而媒體產品則提供 /books、/magazines 和/或 /movies 的資源。API 右側是 API 呼叫的後端資源，包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

在這個圖表中，API 包含兩項產品，每項產品各含三個 API 資源。

身為 API 供應商，您必須負責建構 API 和 API 產品，以便處理存取控制、使用限制和其他業務需求。例如，您可以：

  • 發布免費的 API 產品，允許使用者對 API 資源進行唯讀存取。
  • 以低價發布第二個 API 產品，允許讀取/寫入與免費版相同的 API 資源，但設有較低的存取限制，例如每日 1000 個要求。
  • 以較高的價格發布第三個 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、/magazines 和/或 /movies 的資源。API 右側是 API 呼叫的後端資源，包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

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

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

  • 使用 Apigee Edge 管理 API，將註冊功能整合至現有網站。Edge Management API 是 REST API，可用於執行開發人員註冊流程的所有步驟。詳情請參閱「使用 Edge 管理 API 發布 API」。
  • 使用 Apigee Developer Services 入口網站註冊開發人員。這個入口網站內建了開發人員註冊支援功能，但也提供許多其他功能來支援您的 API。詳情請參閱「什麼是開發人員入口網站？」。

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

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

從左到右的循序圖，顯示開發人員、應用程式、API 和後端服務。應用程式、要求/回應和 API 金鑰箭頭已醒目顯示。從開發人員指向開發人員所建構的應用程式圖示，從應用程式和返回應用程式的箭頭，會顯示要求和回應流向 API 圖示，並在要求上方放置應用程式索引鍵。API 圖示和資源已醒目顯示。API 圖示下方有兩組資源路徑，分別歸類為兩個 API 產品：位置資訊產品和媒體產品。位置產品提供 /countries、/cities 和/或 /languages 的資源，而媒體產品則提供 /books、/magazines 和/或 /movies 的資源。API 右側是 API 呼叫的後端資源，包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

在應用程式註冊時，開發人員會選取一或多項 API 產品。舉例來說，您可以針對不同類型的服務和價格方案發布多個 API 產品。如此一來，應用程式開發人員就能從可用 API 產品清單中挑選所需的產品。

為了回應在 Edge 上註冊應用程式，Edge 會為應用程式指派專屬的 API 金鑰。應用程式必須在每項 API 資源要求中傳遞該 API 金鑰。系統會驗證金鑰，如果有效，就會核准要求。您可以隨時撤銷金鑰，讓應用程式無法再存取您的 API。

您可以決定要如何註冊應用程式。您可以採取以下做法：

  • 使用手動程序，要求開發人員與貴機構聯絡，以便註冊應用程式。您會回覆開發人員 API 金鑰，可能會透過電子郵件傳送。
  • 使用 Edge Management API，將應用程式註冊功能和金鑰提交作業整合至網站。
  • 如果是付費的 Edge 帳戶，請使用 Apigee 開發人員服務入口網站，該入口網站內建支援應用程式註冊和 API 金鑰提交功能。

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

工作 4：製作 API 說明文件

發布 API 產品時，提供說明文件和開發人員意見回饋機制是一項重要考量。開發人員入口網站提供的社群發布功能，越來越常用於與開發社群溝通。這包括傳達靜態內容 (例如 API 說明文件和使用條款)，以及社群貢獻的動態內容 (例如網誌和論壇)，以及客戶支援功能。

從左到右的循序圖，顯示開發人員、應用程式、API 和後端服務。開發人員圖示已醒目顯示。開發人員下方有一個代表開發人員入口網站的方塊。入口網站包含 API 說明文件、範例、教學課程、API 參考資料等。這個入口網站也包含網誌、論壇和支援入口網站。 從醒目顯示的開發人員圖示，連接至該開發人員所建構的應用程式圖示。從應用程式和返回應用程式的箭頭，會顯示要求和回應流向 API 圖示，並在要求上方顯示應用程式金鑰。API 圖示下方有兩組資源路徑，分別歸類為兩個 API 產品：位置資訊產品和媒體產品。位置產品提供 /countries、/cities 和/或 /languages 的資源，而媒體產品則提供 /books、/magazines 和/或 /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 管理 API 是 REST API，可讓您使用任何 HTTP 用戶端存取 API 服務。Apigee 使用 SmartDocs 為 Edge 管理 API 建立互動式說明文件。請參閱這篇文章，瞭解該 API 的說明文件。

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