練習 - 建立後端 API

已完成

在此練習中,您會了解如何執行下列動作:

  • 建立 API 管理 (APIM) 執行個體
  • 匯入 API
  • 設定後端設定
  • 測試 API

必要條件

  • 具有有效訂用帳戶的 Azure 帳戶。 如果尚未有訂用帳戶,則可在 https://azure.com/free 註冊免費試用版。

登入 Azure

  1. 登入 Azure 入口網站,並開啟 Cloud Shell。

    Cloud Shell 啟動按鈕的位置。

  2. 在命令介面開啟之後,請務必選取 [Bash] 環境。

    選取 Bash 環境。

建立 API 管理執行個體

  1. 讓我們為 CLI 命令設定一些變數,以用於減少重新輸入的次數。 將 <myLocation> 取代為對您有意義的區域。 APIM 名稱必須是全域唯一的名稱,而下列指令碼會產生隨機字串。 將 <myEmail> 取代為您可以存取的電子郵件地址。

    myApiName=az204-apim-$RANDOM
    myLocation=<myLocation>
    myEmail=<myEmail>
    
  2. 建立資源群組。 下列命令會建立名為 az204-apim-rg 的資源群組。

    az group create --name az204-apim-rg --location $myLocation
    
  3. 建立 APIM 執行個體。 az apim create 可用來建立此執行個體。 --sku-name Consumption 選項可用來加速逐步解說的程序。

    az apim create -n $myApiName \
        --location $myLocation \
        --publisher-email $myEmail  \
        --resource-group az204-apim-rg \
        --publisher-name AZ204-APIM-Exercise \
        --sku-name Consumption 
    

    注意

    此作業應該會在約五分鐘內完成。

匯入後端 API

本節示範如何匯入和發佈 OpenAPI 規格後端 API。

  1. 在 Azure 入口網站中,搜尋並選取 API 管理服務

  2. 在 [API 管理] 畫面中,選取您建立的 API 管理執行個體。

  3. 在 [API 管理服務] 瀏覽窗格的 [API] 下選取 [API]

    在服務瀏覽窗格中選取 API。

  4. 從清單中選取 [OpenAPI],然後選取快顯中的 [完整]

    OpenAPI 對話方塊。下表會詳述欄位。

    使用下表中的值來填寫表單。 您可以保留任何欄位不提及其預設值。

    設定 Description
    OpenAPI 規格 https://bigconference.azurewebsites.net/ 參考實作 API 的服務,要求會轉送到此位址。 在輸入此值之後,表單中大部分的必要資訊都會自動填入。
    顯示名稱 大型會議 API 此名稱會顯示於開發人員入口網站中。
    名稱 big-conference-api 為 API 提供唯一的名稱。
    說明 已自動填入 提供 API 的選擇性描述。
  5. 選取 建立

設定 API 設定

大型會議 API 已建立。 設定 API 設定。

  1. 選取右側刀鋒視窗中 [設定]

  2. 確認 https://bigconference.azurewebsites.net/ 是位於 [Web 服務 URL] 欄位中。

  3. 取消選取 [需要訂閱] 核取方塊。

    指定 API 的後端 URL。

  4. 選取 [儲存]。

測試 API

現在 API 已匯入並設定好,您可以測試 API。

  1. 選取 [測試]。

    在右側窗格中,選取 [測試]。

  2. 選取 [Speakers_Get]。 頁面會顯示 [查詢參數] 和 [標頭] (如果有的話)。

  3. 請選取傳送

    後端會回應 200 OK 與部分資料。

清除 Azure 資源

完成您在此練習中建立的資源時,您可以使用下列命令來刪除資源群組及所有相關資源。

az group delete --name az204-apim-rg