開始使用主RESTAPI控台 - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

開始使用主RESTAPI控台

在此入門練習中,您會使用API閘道RESTAPI主控台建RESTAPI立無伺服器。無伺服器可APIs讓您專注於應用程式,而不必花時間佈建和管理伺服器。此練習過程不到 20 分鐘即可完成,而且可以包含在 AWS 免費方案中。

首先,使用 Lambda 主控台建立 Lambda 函數。接下來,您可以RESTAPI使用API閘道RESTAPI主控台建立。然後,您可以建立一個API方法,並使用 Lambda 代理整合將其與 Lambda 函數整合。最後,您部署和調用API.

當您叫用時 RESTAPI,API閘道會將請求路由到您的 Lambda 函數。Lambda 會執行函數,並將回應傳回至API閘道。APIGateway 接著會將該回應傳回給您。

RESTAPI您在本自學課程中建立的概述。

若要完成本練習,您需要具有主控台存取權的 AWS 帳戶 和 AWS Identity and Access Management (IAM) 使用者。如需詳細資訊,請參閱設定 以使用 API Gateway

步驟 1:建立 Lambda 函數

您可以使用 Lambda 函數做為API. Lambda 只有在需要時才會執行程式碼,可自動從每天數項請求擴展成每秒數千項請求。

在本練習中,您將使用 Lambda 主控台中的預設 Node.js 函數。

建立 Lambda 函式
  1. https://console.aws.amazon.com/lambda 登入 Lambda 主控台。

  2. 選擇建立函數

  3. Basic information (基本資訊) 下,為 Function name (函數名稱) 輸入 my-function

  4. 對於所有其他選項,請使用預設設定。

  5. 選擇建立函數

預設 Lambda 函數程式碼看起來與下面所示類似:

export const handler = async (event) => { const response = { statusCode: 200, body: JSON.stringify('The API Gateway REST API console is great!'), }; return response; };

只要函數的回應符合API閘道所需的格式,您就可以針對此練習修改 Lambda 函數。

將預設回應內文 (Hello from Lambda!) 取代為 The API Gateway REST API console is great!。當您調用範例函數時,它會將 200 回應傳回至用戶端,並且包含更新的回應。

步驟 2:建立 REST API

接下來,您使RESTAPI用根資源(/)創建一個。

若要建立 REST API
  1. https://console.aws.amazon.com/ap igateway 登入API閘道主控台。

  2. 執行以下任意一項:

    • 若要建立您的第一個 API RESTAPI,請選擇 [建置]。

    • 如果您已建立API之前,請選擇 [建立]API,然後選擇 [建置] RESTAPI

  3. 對於API名稱,輸入my-rest-api

  4. 描述,請輸入描述。

  5. 保持API端點類型設定為 [地區]。

  6. 選擇 [建立] API。

步驟 3:建立 Lambda 代理整合

接下來,您可以在根資源 (/) REST API 上建立API方法,並使用代理整合將該方法與 Lambda 函數整合。在 Lambda 代理整合中,API閘道會將來自用戶端的傳入要求直接傳送至 Lambda 函數。

若要建立 Lambda 代理整合
  1. 選取 / 資源,然後選擇建立方法

  2. 針對方法類型,選取 ANY

  3. 針對整合類型,選取 Lambda

  4. 開啟 Lambda 代理整合

  5. 針對 Lambda 函數,輸入 my-function,然後選取您的 Lambda 函數。

  6. 選擇建立方法

步驟 4:部署 API

接下來,您可以建立API部署並將其與階段產生關聯。

若要部署您的 API
  1. 選擇部署API

  2. 針對階段,選取新階段

  3. 針對階段名稱,輸入 Prod

  4. 描述,請輸入描述。

  5. 選擇部署

現在客戶可以打電話給您的API. 若要API在部署之前對其進行測試,您可以選擇性地選擇ANY方法,導覽至 [測試] 索引標籤,然後選擇 [測試]。

步驟 5:調用您的 API

要調用您的 API
  1. 從主導覽窗格選擇階段

  2. 階段詳細資料下,選擇複製圖示以複製您API的呼叫URL。

    創建後 RESTAPI,控制台會顯示您API的調用URL。
  3. 在網頁瀏覽器URL中輸入呼叫。

    完整的URL應該看起來像https://abcd123.execute-api.us-east-2.amazonaws.com/Prod

    您的瀏覽器會傳送GET要求至API。

  4. 驗證您API的回應。您應該會在瀏覽器中看到文字 "The API Gateway REST API console is great!"

(選用) 步驟 6:清除

若要避免產生不必要的成本 AWS 帳戶,請刪除您在本練習中建立的資源。下列步驟會刪除您RESTAPI的 Lambda 函數和相關聯的資源。

若要刪除您的 REST API
  1. 在 [資源] 窗格中,選擇 [API動作] > [刪除] API。

  2. 在 [除] API 對話方塊中,輸入 [確認],然後選擇 [刪除]。

若要刪除 Lambda 函數
  1. https://console.aws.amazon.com/lambda 登入 Lambda 主控台。

  2. 函數頁面上,選取您的函數。選擇 動作刪除

  3. 刪除 1 函數對話方塊中輸入 delete,然後選擇刪除

若要刪除 Lambda 函數的日誌群組
  1. 開啟 Amazon CloudWatch 主控台的日誌群組頁面

  2. 日誌群組頁面上,選取函數的日誌群組 (/aws/lambda/my-function)。然後針對動作,選擇刪除日誌群組

  3. 刪除日誌群組 對話方塊中,選擇 刪除

若要刪除 Lambda 函數的執行角色
  1. 開啟主IAM控台的 [角色] 頁面

  2. (選用) 在角色頁面的搜尋方塊中,輸入 my-function

  3. 選取函數的角色 (例如 my-function-31exxmpl),然後選擇刪除

  4. 要刪除 my-function-31exxmpl 嗎?對話方塊中,輸入角色的名稱,然後選擇刪除

提示

您可以使用 AWS CloudFormation or AWS Serverless Application Model (AWS SAM) 自動建立和清理 AWS 資源。有關某些示例 AWS CloudFormation 模板,請參閱 awsdocs GitHub 存儲庫中API網關的示例模板。