在 API Gateway 中設定基本請求驗證

若要建立 AWS CloudFormation 堆疊

1. 開啟位於 https://console.aws.amazon.com/cloudformation 的 AWS CloudFormation 主控台。

2. 選擇 Create stack (建立堆疊)，然後選擇 With new resources (standard) (使用新資源 (標準))。

3. 對於 Specify template (指定範本)，選擇 Upload a template file (上傳範本檔案)。

4. 選取您下載的範本。

5. 選擇 Next (下一步)。

6. 針對 Stack name (堆疊名稱)，輸入 request-validation-tutorial-console，然後選擇 Next (下一步)。

7. 針對 Configure stack options (設定堆疊選項)，選擇 Next (下一步)。

8. 針對 Capabilities (功能)，請確認 AWS CloudFormation 可以在您的帳戶中建立 IAM 資源。

9. 選擇提交。

選取新建立的 API

1. 選取新建立的 request-validation-tutorial-console 堆疊。

2. 選擇 Resources (資源)。

3. 在實體 ID 下，選擇您的 API。此連結會將您導向至 API Gateway 主控台。

建立裝置

1. 需有模型才能在傳入請求的內文上使用請求驗證。若要建立模型，請在主導覽窗格中選擇模型。

2. 選擇建立模型。

3. 對於名稱，輸入 PetStoreModel。

4. 針對內容類型，輸入 application/json。如果找不到相符的內容類型，則不會執行請求驗證。若要使用相同的模型，而不論內容類型為何，請輸入 $default。

5. 對於描述，輸入 My PetStore Model 作為模型描述。

6. 對於模型結構描述，將下列模型貼入程式碼編輯器中，然後選擇建立。

   {
     "type" : "object",
     "required" : [ "name", "price", "type" ],
     "properties" : {
       "id" : {
         "type" : "integer"
       },
       "type" : {
         "type" : "string",
         "enum" : [ "dog", "cat", "fish" ]
       },
       "name" : {
         "type" : "string"
       },
       "price" : {
         "type" : "number",
         "minimum" : 25.0,
         "maximum" : 500.0
       }
     }
   }

設定 GET 方法的請求驗證

1. 在主導覽窗格中，選擇資源，然後選取 GET 方法。

2. 在方法請求索引標籤的方法請求設定下，選擇編輯。

3. 對於請求驗證程式，選取驗證查詢字串參數與標頭。

4. 在 URL 查詢字串參數下，執行下列動作：

   1. 選擇新增查詢字串。

   2. 對於名稱，輸入 petType。

   3. 開啟必要。

   4. 讓快取保持關閉。

5. 選擇儲存。

6. 在整合請求索引標籤上，於整合請求設定下，選擇編輯。

7. 在 URL 查詢字串參數下，執行下列動作：

   1. 選擇新增查詢字串。

   2. 對於名稱，輸入 petType。

   3. 對於映射自，輸入 method.request.querystring.petType。這會將 petType 對應到寵物的類型。

      如需資料對應的詳細資訊，請參閱資料對應教學課程。

   4. 讓快取保持關閉。

8. 選擇儲存。

測試 GET 方法的請求驗證

1. 選擇測試標籤。您可能需要選擇向右箭頭按鈕才能顯示此索引標籤。

2. 對於查詢字串，輸入 petType=dog，然後選擇測試。

3. 方法測試會傳回 200 OK 及狗的清單。

   如需如何轉換此輸出資料的相關資訊，請參閱資料對應教學課程。

4. 移除 petType=dog 並選擇測試。

5. 方法測試會傳回 400 錯誤，並顯示下列錯誤訊息：

   {
     "message": "Missing required request parameters: [petType]"
   }

設定 POST 方法的請求驗證

1. 在主導覽窗格中，選擇資源，然後選取 POST 方法。

2. 在方法請求索引標籤的方法請求設定下，選擇編輯。

3. 對於請求驗證程式，選取驗證內文。

4. 在請求內文下，選擇新增模型。

5. 針對內容類型，輸入 application/json。如果找不到相符的內容類型，則不會執行請求驗證。若要使用相同的模型，而不論內容類型為何，請輸入 $default。

   對於模型，選取 PetStoreModel。

6. 選擇儲存。

測試 POST 方法的請求驗證

1. 選擇測試標籤。您可能需要選擇向右箭頭按鈕才能顯示此索引標籤。

2. 對於請求內文，將下列內容貼入程式碼編輯器中：

   {
     "id": 2,
     "name": "Bella",
     "type": "dog",
     "price": 400
   }

   選擇 Test (測試)。

3. 方法測試會傳回 200 OK 和成功訊息。

4. 對於請求內文，將下列內容貼入程式碼編輯器中：

   {
     "id": 2,
     "name": "Bella",
     "type": "dog",
     "price": 4000
   }

   選擇測試。

5. 方法測試會傳回 400 錯誤，並顯示下列錯誤訊息：

   {
    "message": "Invalid request body"
   }

   測試日誌底部會傳回請求內文無效的原因。在此案例中，寵物的價格超出了模型中指定的最高價格。

刪除 AWS CloudFormation 堆疊

1. 開啟位於 https://console.aws.amazon.com/cloudformation 的 AWS CloudFormation 主控台。

2. 選取您的 AWS CloudFormation 堆疊。

3. 選擇刪除，然後確認您的選擇。

若要建立 AWS CloudFormation 堆疊

下載並解壓縮應用程式建立範本 AWS CloudFormation。

若要完成下列教學課程，您需要 AWS Command Line Interface (AWS CLI) 第 2 版。

對於長命令，逸出字元 (\) 用於將命令分割為多行。

1. 使用下列命令建立 AWS CloudFormation 堆疊。

   aws cloudformation create-stack --stack-name request-validation-tutorial-cli --template-body file://request-validation-tutorial-cli.zip --capabilities CAPABILITY_NAMED_IAM 

2. AWS CloudFormation 佈建在範本中指定的資源。完成資源佈建可能需要幾分鐘的時間。使用下列命令來查看 AWS CloudFormation 堆疊的狀態。

   aws cloudformation describe-stacks --stack-name request-validation-tutorial-cli

3. 當 AWS CloudFormation 堆疊的狀態為 StackStatus: "CREATE_COMPLETE" 時，請使用下列命令擷取未來步驟的相關輸出值。

    aws cloudformation describe-stacks --stack-name request-validation-tutorial-cli --query "Stacks[*].Outputs[*].{OutputKey: OutputKey, OutputValue: OutputValue, Description: Description}"

   輸出值如下：

   • ApiId，這是 API 的 ID。對於本教學課程，API ID 為 abc123。

   • ResourceId，這是 GET 和 POST 方法公開所在驗證程式資源的 ID。對於本教學課程，資源 ID 為 efg456

建立請求驗證程式並匯入模型

1. 需有驗證程式才能搭配 AWS CLI 使用請求驗證。使用下列命令建立僅驗證請求參數的驗證程式。

   aws apigateway create-request-validator --rest-api-id abc123 \
         --no-validate-request-body \
         --validate-request-parameters \
         --name params-only

   請記下 params-only 驗證程式的 ID。

2. 使用下列命令建立僅驗證請求內文的驗證程式。

   aws apigateway create-request-validator --rest-api-id abc123 \
         --validate-request-body \
         --no-validate-request-parameters \
         --name body-only

   請記下 body-only 驗證程式的 ID。

3. 需有模型才能在傳入請求的內文上使用請求驗證。使用下列命令匯入模型。

   aws apigateway create-model --rest-api-id abc123 --name PetStoreModel --description 'My PetStore Model' --content-type 'application/json' --schema '{"type": "object", "required" : [ "name", "price", "type" ], "properties" : { "id" : {"type" : "integer"},"type" : {"type" : "string", "enum" : [ "dog", "cat", "fish" ]},"name" : { "type" : "string"},"price" : {"type" : "number","minimum" : 25.0, "maximum" : 500.0}}}}' 

   如果找不到相符的內容類型，則不會執行請求驗證。若要使用相同的模型，而不論內容類型為何，請指定 $default 為索引鍵。

建立 GET 和 POST 方法

1. 使用下列命令，在 /validate 資源上新增 GET HTTP 方法。此命令會建立 GET 方法、新增 params-only 驗證程式，並視需要設定查詢字串 petType。

   aws apigateway put-method --rest-api-id abc123 \
          --resource-id efg456 \
          --http-method GET \
          --authorization-type "NONE" \
          --request-validator-id aaa111 \
          --request-parameters "method.request.querystring.petType=true"

   使用下列命令，在 /validate 資源上新增 POST HTTP 方法。此命令會建立 POST 方法、新增 body-only 驗證程式，並將模型附加至僅內文驗證程式。

   aws apigateway put-method --rest-api-id abc123 \
          --resource-id efg456 \
          --http-method POST \
          --authorization-type "NONE" \
          --request-validator-id bbb222 \
          --request-models 'application/json'=PetStoreModel

2. 使用下列命令設定 GET /validate 方法的 200 OK 回應。

   aws apigateway put-method-response --rest-api-id abc123  \
               --resource-id efg456 \
               --http-method GET \
               --status-code 200

   使用下列命令設定 POST /validate 方法的 200 OK 回應。

   aws apigateway put-method-response --rest-api-id abc123  \
               --resource-id efg456 \
               --http-method POST \
               --status-code 200

3. 使用下列命令，為 GET /validation 方法設定具有所指定 HTTP 端點的 Integration。

   aws apigateway put-integration --rest-api-id abc123  \
               --resource-id efg456 \
               --http-method GET \
               --type HTTP \
               --integration-http-method GET \
               --request-parameters '{"integration.request.querystring.type" : "method.request.querystring.petType"}' \
               --uri 'http://petstore-demo-endpoint.execute-api.com/petstore/pets'

   使用下列命令，為 POST /validation 方法設定具有所指定 HTTP 端點的 Integration。

   aws apigateway put-integration --rest-api-id abc123  \
                 --resource-id efg456 \
                 --http-method POST \
                 --type HTTP \
                 --integration-http-method GET \
                 --uri 'http://petstore-demo-endpoint.execute-api.com/petstore/pets'

4. 使用下列命令設定 GET /validation 方法的整合回應。

   aws apigateway put-integration-response --rest-api-id abc123 \
                 --resource-id efg456\
                 --http-method GET \
                 --status-code 200 \
                 --selection-pattern ""

   使用下列命令設定 POST /validation 方法的整合回應。

   aws apigateway put-integration-response --rest-api-id abc123 \
               --resource-id efg456 \
               --http-method POST \
               --status-code 200 \
               --selection-pattern ""

若要測試 API

1. 若要測試將為查詢字串執行請求驗證的 GET 方法，請使用下列命令：

   aws apigateway test-invoke-method --rest-api-id abc123 \
               --resource-id efg456 \
               --http-method GET \
               --path-with-query-string '/validate?petType=dog'

   結果將傳回 200 OK 和狗清單。

2. 在不包括查詢字串 petType 的情況下，使用下列命令進行測試，

   aws apigateway test-invoke-method --rest-api-id abc123 \
               --resource-id efg456 \
               --http-method GET

   結果將傳回 400 錯誤。

3. 若要測試將為請求內文執行請求驗證的 POST 方法，請使用下列命令：

    aws apigateway test-invoke-method --rest-api-id abc123 \
               --resource-id efg456 \
               --http-method POST \
               --body '{"id": 1, "name": "bella", "type": "dog", "price" : 400 }'

   結果將傳回 200 OK 和成功訊息。

4. 使用下列命令，以利用無效內文進行測試。

    aws apigateway test-invoke-method --rest-api-id abc123 \
                 --resource-id efg456 \
                 --http-method POST \
                 --body '{"id": 1, "name": "bella", "type": "dog", "price" : 1000 }'

   結果將傳回 400 錯誤，因為狗的價格超過了模型定義的最高價格。

刪除 AWS CloudFormation 堆疊

• 使用下列命令刪除您的 AWS CloudFormation 資源。

  aws cloudformation delete-stack  --stack-name request-validation-tutorial-cli