發布總覽

您目前查看的是 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 Management API 或 UI 建立 API 產品。(如要進一步瞭解 API 產品，請參閱「什麼是 API 產品？」一文)。

從左到右的循序圖，顯示開發人員、應用程式、API 和後端服務。API 圖示和資源會醒目顯示。虛線從開發人員指向開發人員建構的應用程式圖示。從應用程式到 API 圖示，以及從 API 圖示返回應用程式的箭頭，顯示要求和回應流程，應用程式金鑰位於要求上方。API 圖示和資源會醒目顯示。API 圖示下方有兩組資源路徑，分別歸入兩個 API 產品：地點產品和媒體產品。Location 產品有 /countries、/cities 和 /languages 的資源，而 Media 產品則有 /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 圖示下方有兩組資源路徑，分別歸入兩個 API 產品：地點產品和媒體產品。Location 產品有 /countries、/cities 和 /languages 的資源，而 Media 產品則有 /books、/magazines 和 /movies 的資源。API 右側是 API 呼叫的後端資源，包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

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

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 圖示下方有兩組資源路徑，分別歸入兩個 API 產品：地點產品和媒體產品。Location 產品有 /countries、/cities 和 /languages 的資源，而 Media 產品則有 /books、/magazines 和 /movies 的資源。API 右側是 API 呼叫的後端資源，包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

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

在 Edge 上註冊應用程式後，Edge 會為應用程式指派專屬 API 金鑰。應用程式必須將該 API 金鑰做為每個 API 資源要求的其中一部分傳遞。系統會驗證金鑰，如果金鑰有效，就會核准要求。服務供應商隨時可以撤銷金鑰，禁止應用程式存取 API。

身為 API 供應商，您可以決定要如何註冊應用程式。您可以採取以下做法：

  • 使用手動程序，要求開發人員與貴機構聯絡，註冊應用程式。您會透過電子郵件等方式，將 API 金鑰傳送給開發人員。
  • 使用 Edge 管理 API，將應用程式註冊功能和金鑰傳送功能整合至網站。
  • 如果是付費 Edge 帳戶，請使用 Apigee 開發人員服務入口網站，該入口網站內建應用程式註冊和 API 金鑰傳送功能。

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

工作 4：製作 API 說明文件

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

從左到右的循序圖，顯示開發人員、應用程式、API 和後端服務。醒目顯示開發人員圖示。開發人員下方是代表開發人員入口網站的方塊。入口網站包含 API 說明文件、範例、教學課程、API 參考資料等。入口網站也包含網誌、論壇和支援入口網站。 從醒目顯示的開發人員指向開發人員所建構應用程式的圖示，會顯示虛線。箭頭從應用程式指向 API 圖示，再返回應用程式，表示要求和回應流程，應用程式金鑰位於要求上方。API 圖示下方有兩組資源路徑，分別歸入兩個 API 產品：地點產品和媒體產品。Location 產品有 /countries、/cities 和 /languages 的資源，而 Media 產品則有 /books、/magazines 和 /movies 的資源。API 右側是 API 呼叫的後端資源，包括資料庫、企業服務匯流排、應用程式伺服器和一般後端。

您可以自行建構網站來部署說明文件，或使用 Apigee Developer Services 入口網站 (適用於付費 Edge 帳戶)。入口網站內建支援說明文件、網誌、論壇，以及支援開發人員社群所需的其他類型內容。

SmartDocs 可讓您在開發人員服務入口網站中記錄 API，並以全互動式方式呈現 API 說明文件。透過 SmartDocs 提供的互動式說明文件，入口網站使用者可以：

  • 閱讀 API 相關資訊
  • 傳送即時要求至 API
  • 查看 API 傳回的即時回應

舉例來說，下圖顯示入口網站上使用 SmartDocs 記錄的 API。這個 API 可提供特定地點的天氣資訊：

SmartDocs API 方法主題，可讓您按一下主題中的按鈕呼叫天氣 API。

開發人員輸入「w」查詢參數的值來指定位置，然後按一下「傳送要求」按鈕，即可查看即時要求和回應。為 API 建立互動式說明文件，可讓入口網站使用者輕鬆瞭解、測試及評估 API。

Edge 管理 API 是 REST API，可讓您使用任何 HTTP 用戶端存取 API 服務。Apigee 使用 SmartDocs 為 Edge 管理 API 建立互動式說明文件。請參閱這份 API 說明文件。

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