API Gateway의 기본 요청 확인 설정

AWS CloudFormation 스택을 생성하려면

1. AWS CloudFormation 콘솔(https://console.aws.amazon.com/cloudformation)을 엽니다.

2. 스택 생성을 선택한 다음 새 리소스 사용(표준)을 선택합니다.

3. 템플릿 지정에서 템플릿 파일 업로드를 선택합니다.

4. 다운로드한 템플릿을 선택합니다.

5. 다음을 선택합니다.

6. 스택 이름에 request-validation-tutorial-console을 입력하고 다음을 선택합니다.

7. 스택 옵션 구성에서 다음을 선택합니다.

8. 기능의 경우 AWS CloudFormation이 계정에 IAM 리소스를 생성할 수 있음을 확인합니다.

9. 제출을 선택합니다.

새로 생성한 API를 선택하는 방법

1. 새로 생성한 request-validation-tutorial-console 스택을 선택합니다.

2. 리소스를 선택합니다.

3. 물리적 ID에서 API를 선택합니다. 이 링크는 API Gateway 콘솔로 연결됩니다.

모델을 생성하는 방법

1. 수신 요청의 본문에서 요청 확인을 사용하려면 모델이 필요합니다. 모델을 생성하려면 기본 탐색 창에서 모델을 선택합니다.

2. Create model(모델 생성)을 선택합니다.

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. 쿼리 문자열 추가(Add query string)를 선택합니다.

   2. 이름에 petType을 입력합니다.

   3. 필수를 끕니다.

   4. 캐싱을 꺼진 상태로 둡니다.

5. Save(저장)를 선택합니다.

6. 통합 요청 탭의 통합 요청 설정에서 편집을 선택합니다.

7. URL 쿼리 문자열 파라미터에서 다음을 수행합니다.

   1. 쿼리 문자열 추가(Add query string)를 선택합니다.

   2. 이름에 petType을 입력합니다.

   3. 다음에서 매핑됨에 method.request.querystring.petType을 입력합니다. 이렇게 하면 petType이 반려동물의 유형에 매핑됩니다.

      데이터 매핑에 대한 자세한 내용은 데이터 매핑 자습서를 참조하세요.

   4. 캐싱을 꺼진 상태로 둡니다.

8. Save(저장)를 선택합니다.

GET 메서드에 대한 요청 검사를 테스트하려면

1. 테스트 탭을 선택합니다. 탭을 표시하려면 오른쪽 화살표 버튼을 선택해야 할 수도 있습니다.

2. 쿼리 문자열에 petType=dog를 입력하고 테스트를 선택합니다.

3. 메서드 테스트에서 200 OK와 dog 목록이 반환됩니다.

   이 출력 데이터를 변환하는 방법에 대한 자세한 내용은 데이터 매핑 자습서를 참조하세요.

4. petType=dog를 제거하고 테스트를 선택합니다.

5. 메서드 테스트에서 다음 오류 메시지와 함께 400 오류가 반환됩니다.

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

POST 메서드에 대한 요청 검사를 구성하려면

1. 기본 탐색 창에서 리소스를 선택하고 POST 메서드를 선택합니다.

2. 메서드 요청 탭의 메서드 요청 설정에서 편집을 선택합니다.

3. 요청 검사기에서 본문 검사를 선택합니다.

4. 요청 본문에서 모델 추가를 선택합니다.

5. 콘텐츠 유형으로 application/json을 입력한 다음 모델에서 PetStoreModel을 선택합니다.

6. Save(저장)를 선택합니다.

POST 메서드에 대한 요청 검사를 테스트하려면

1. 테스트 탭을 선택합니다. 탭을 표시하려면 오른쪽 화살표 버튼을 선택해야 할 수도 있습니다.

2. 요청 본문에서 다음을 코드 편집기에 붙여 넣습니다.

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

   테스트를 선택합니다.

3. 메서드 테스트에서 200 OK와 함께 성공 메시지가 반환됩니다.

4. 요청 본문에서 다음을 코드 편집기에 붙여 넣습니다.

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

   테스트를 선택합니다.

5. 메서드 테스트에서 다음 오류 메시지와 함께 400 오류가 반환됩니다.

   {
    "message": "Invalid request body"
   }

   테스트 로그 하단에 잘못된 요청 본문의 이유가 반환됩니다. 이 경우 반려동물의 가격이 모델에 명시된 최대 가격을 벗어났습니다.

AWS CloudFormation 스택을 삭제하려면

1. AWS CloudFormation 콘솔(https://console.aws.amazon.com/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