教學課程：建立和發行產品

適用於：所有 API 管理 層

在 Azure API 管理中，一項產品會包含一或多個 API、使用量配額和使用規定。 產品發行後，開發人員即可訂閱產品，並開始使用產品的 API。

在本教學課程中，您會了解如何：

• 建立和發佈產品
• 將 API 新增至產品
• 存取產品 API

必要條件

• 了解 Azure API 管理術語。
• 完成下列快速入門：建立 Azure API 管理執行個體。
• 同時也請完成下列教學課程：匯入和發佈您的第一個 API。

建立和發佈產品

入口網站

1. 登入 Azure 入口網站，然後瀏覽至您的 API 管理執行個體。

2. 在左側瀏覽窗格中，選取 [產品]>[+ 新增]。

   

3. 在 [新增產品] 視窗中，輸入下表所述的值，以建立您的產品。

   

   名稱	描述
   Display name	您想要其顯示在開發人員入口網站中的名稱。
   描述	提供產品的相關資訊，例如用途、提供存取權的 API，以及其他詳細資料。
   州/省	如果您想要發行產品，請選取 [發行]。 產品必須發行，才能呼叫產品中的 API。 根據預設，新產品是未發行的狀態，而且只有管理員群組才看的見。
   需要訂用帳戶	選取使用者是否需要訂閱才能使用產品 (產品受到「保護」)，而且必須使用訂閱金鑰存取產品的 API。 如果不需訂閱 (產品是「開放」的)，便不必使用訂閱金鑰存取產品的 API。 請參閱本文稍後的存取產品 API。
   需要核准	如果您希望管理員檢閱並接受或拒絕對此產品的訂閱嘗試，請加以選取。 如果未選取，將會自動核准訂閱嘗試。
   訂閱計數限制	可選擇限制多個同時訂閱的總數。
   法律條款	您可以包含訂閱者必須接受才可使用產品的產品使用規定。
   API	選取一或多個 API。 您也可以在建立產品之後新增 API。 如需詳細資訊，請參閱本文稍後的將API 新增至產品。 如果產品是開放的 (無須訂閱)，您只能新增與另一個開放式產品沒有關聯的 API。

4. 選取 [建立] 建立新產品。

警告

設定不需要訂閱的產品時，請格外小心。 此設定可能過於寬鬆，而且可能會讓產品的 API 更容易遭受特定的 API 安全性威脅。

Azure CLI

開始使用 Azure CLI：

• 在 Azure Cloud Shell 中使用 Bash 環境。 如需詳細資訊，請參閱 Azure Cloud Shell 中的 Bash 快速入門。

  

• 若要在本地執行 CLI 參考命令，請安裝 Azure CLI。 若您在 Windows 或 macOS 上執行，請考慮在 Docker 容器中執行 Azure CLI。 如需詳細資訊，請參閱〈如何在 Docker 容器中執行 Azure CLI〉。

  • 如果您使用的是本機安裝，請使用 az login 命令，透過 Azure CLI 來登入。 請遵循您終端機上顯示的步驟，完成驗證程序。 如需其他登入選項，請參閱使用 Azure CLI 登入。

  • 出現提示時，請在第一次使用時安裝 Azure CLI 延伸模組。 如需擴充功能詳細資訊，請參閱使用 Azure CLI 擴充功能。

  • 執行 az version 以尋找已安裝的版本和相依程式庫。 若要升級至最新版本，請執行 az upgrade。

若要建立產品，請執行 az apim product create 命令：

az apim product create --resource-group apim-hello-word-resource-group \
    --product-name "Contoso product" --product-id contoso-product \
    --service-name apim-hello-world --subscription-required true \
    --state published --description "This is a test."

您可以為產品指定各種不同的值：

參數	描述
--product-name	您想要其顯示在開發人員入口網站中的名稱。
--description	提供產品的相關資訊，例如用途、提供存取權的 API，以及其他詳細資料。
--state	如果您要發行產品，請選取 [發行]。 產品必須發行，才能呼叫產品中的 API。 根據預設，新產品是未發行的狀態，而且只有管理員群組才看的見。
--subscription-required	選擇使用者是否需要訂閱才能使用產品 (產品受到保護) 或不需訂閱 (產品開放)。 請參閱本文稍後的存取產品 API。
--approval-required	如果您希望管理員檢閱並接受或拒絕對此產品的訂閱嘗試，請加以選取。 如果未選取，將會自動核准訂閱嘗試。
--subscriptions-limit	您可以選擇是否限制多個同時訂閱的總數。
--legal-terms	您可以包含產品使用規定，即訂閱者必須接受規定才能使用產品。

警告

設定不需要訂閱的產品時，請格外小心。 此設定可能過於寬鬆，而且可能會讓產品的 API 更容易遭受特定的 API 安全性威脅。

若要查看您目前的產品，請使用 az apim product list 命令：

az apim product list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table

您可以使用 az apim product delete 命令刪除產品：

az apim product delete --product-id contoso-product \
    --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --delete-subscriptions true

新增更多設定

儲存之後，繼續設定產品。 在您的 API 管理執行個體中，從 [產品] 視窗中選取產品。 新增或更新：

項目	說明
設定	產品中繼資料和狀態
API	與產品相關聯的 API
原則	套用至產品 API 的原則
存取控制	開發人員或來賓的產品可見度
訂用帳戶	產品訂閱者

將 API 新增至產品中

產品是一或多個 API 的關聯。 您可以包含多個 API，並透過開發人員入口網站將其提供給開發人員。 在產品建立期間，您可以新增一或多個現有的 API。 您可以在之後將 API 新增至產品中，可以從產品的 [設定] 頁面或建立 API 時進行新增。

將 API 新增至現有的產品

入口網站

1. 在 API 管理執行個體的左側導覽中，選取 [產品]。
2. 選取產品，然後選取 [API]。
3. 選取 [+ 新增 API]。
4. 選取一或多個 API，然後選取 [選取]。

Azure CLI

1. 若要查看受控 API，請使用 az apim api list 命令：

   az apim api list --resource-group apim-hello-word-resource-group \
       --service-name apim-hello-world --output table
   

2. 若要新增 API 至您的產品，請執行 az apim product api add 命令：

   az apim product api add --resource-group apim-hello-word-resource-group \
       --api-id demo-conference-api --product-id contoso-product \
       --service-name apim-hello-world
   

3. 使用 az apim product api list 命令確認新增的 API：

   az apim product api list --resource-group apim-hello-word-resource-group \
       --product-id contoso-product --service-name apim-hello-world --output table
   

您可以使用 az apim product api delete 命令，從產品中移除 API：

az apim product api delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --product-id contoso-product \
    --service-name apim-hello-world

存取產品 API

發行產品後，開發人員即可存取 API。 視產品設定方式而定，開發人員可能需要訂閱產品才能存取。

• 受保護的產品 - 開發人員必須先訂閱受保護的產品，才能存取產品的 API。 訂閱後，開發人員即可取得訂閱金鑰，存取該產品中任何 API。 如果您建立了 APIM 執行個體，您就已經是系統管理員，因此根據預設，您已訂閱每一個產品。 如需詳細資訊，請參閱 Azure API 管理中的訂閱。

  在用戶端使用有效的產品訂閱金鑰提出 API 要求時，API 管理會處理要求，並允許就產品的內容進行存取。 為產品所設定的原則和存取控制規則亦可加以套用。

  提示

  您可以透過 REST API 或 PowerShell 命令，使用自訂的訂用帳戶金鑰建立或更新使用者的產品訂用帳戶。

• 開放式產品 - 開發人員不必使用訂閱金鑰，即可存取開放式產品的 API。 但您可以設定其他機制來保護用戶端對 API 的存取，包括 OAuth 2.0、用戶端憑證，及限制呼叫者 IP 位址。

  注意

  開發人員入口網站中並未列出開放式產品，以便讓開發人員能夠了解或訂閱。 只有系統管理員群組才能看到它們。 您必須使用另一個機制來通知開發人員，關於哪些 API 不需訂用帳戶金鑰即可存取的資訊。

  在沒有訂閱金鑰的用戶端提出 API 要求時：

  • API 管理會檢查 API 是否與開放式產品相關。 API 最多可以與一個開放產品相關聯。

  • 如果有開放式產品，API 管理即會就開放式產品的內容來處理要求。 為開放式產品設定的原則和存取控制規則亦可加以套用。

如需詳細資訊，請參閱 API 管理如何處理具備或未具備訂閱金鑰的要求。

下一步

在本教學課程中，您已了解如何：

• 建立和發佈產品
• 將 API 新增至產品
• 存取產品 API

前進到下一個教學課程：

建立空白 API 和模擬 API 回應