API Gateway 콘솔을 사용하여 HTTP 프록시 통합을 통해 API 생성 HTTP 프록시 통합을 사용하여 API 테스트

자습서: HTTP 프록시 통합을 통해 REST API 생성

HTTP 프록시 통합은 웹 애플리케이션이 단일 HTTP 메서드의 간소화된 설정을 통해 전체 웹 사이트와 같은 통합된 HTTP 엔드포인트의 여러 리소스 또는 기능에 액세스할 수 있도록 하는 API를 구축하기 위한 간단하고 강력한 다목적 메커니즘입니다. HTTP 프록시 통합에서 API Gateway는 클라이언트가 제출한 메서드 요청을 백엔드로 전달합니다. 전달된 요청 데이터에는 요청 헤더, 쿼리 문자열 파라미터, URL 경로 변수 및 페이로드가 포함되어 있습니다. 백엔드 HTTP 엔드포인트 또는 웹 서버는 수신되는 요청 데이터를 구문 분석하여 반환하는 응답을 결정합니다. HTTP 프록시 통합을 통해 클라이언트 및 백엔드가 API 메서드가 설정된 후 API Gateway의 개입 없이 직접 상호 작용할 수 있습니다. 단, Amazon API Gateway 중요 정보에 나열된 지원되지 않는 문자 등 알려진 문제점의 경우는 예외입니다.

포괄적인 프록시 리소스 {proxy+} 및 HTTP 메서드에 대한 catch-all ANY 동사를 사용하면 HTTP 프록시 통합을 통해 단일 API 메서드의 API를 생성할 수 있습니다. 메서드는 공개적으로 액세스 가능한 HTTP 리소스의 전체 집합 및 웹 사이트의 작업을 공개합니다. 백엔드 웹 서버가 퍼블릭 액세스를 위해 더 많은 리소스를 열면 클라이언트는 동일한 API 설정으로 이러한 새 리소스를 사용할 수 있습니다. 이렇게 하려면 웹 사이트 개발자는 새 리소스와 각 리소스에 적용 가능한 작업을 클라이언트 개발자에게 정확히 알려야 합니다.

다음 자습서에서는 HTTP 프록시 통합을 간략하게 소개합니다. 자습서에서는 API Gateway 콘솔을 사용해 API를 생성하여 일반 프록시 리소스 {proxy+}를 통해 PetStore 웹 사이트와 통합하고 ANY의 HTTP 메서드 자리 표시자를 생성합니다.

주제

API Gateway 콘솔을 사용하여 HTTP 프록시 통합을 통해 API 생성
HTTP 프록시 통합을 사용하여 API 테스트

API Gateway 콘솔을 사용하여 HTTP 프록시 통합을 통해 API 생성

다음 절차에서는 API Gateway 콘솔을 사용하여 프록시 리소스를 통해 HTTP 백엔드에 대한 API를 생성한 후 테스트하는 단계를 안내합니다. HTTP 백엔드는 PetStore의 http://petstore-demo-endpoint.execute-api.com/petstore/pets 웹 사이트(자습서: HTTP 비 프록시 통합을 통해 REST API 생성)이며 스크린샷은 API Gateway UI 요소를 보여주기 위한 시각적 보조 도구로 사용됩니다. 처음으로 API Gateway 콘솔을 사용하여 API를 생성하는 경우 먼저 해당 섹션을 따를 수 있습니다.

API를 생성하는 방법

https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.
API Gateway를 처음 사용하는 경우, 서비스의 기능을 소개하는 페이지가 나타납니다. REST API에서 빌드를 선택합니다. 예제 API 생성 팝업이 나타나면 확인을 선택합니다.

API Gateway를 처음 사용하는 것이 아닌 경우 API 생성을 선택합니다. REST API에서 빌드를 선택합니다.
API 이름에서 HTTPProxyAPI을 입력합니다.
(선택 사항) 설명에 설명을 입력합니다.
API 엔드포인트 유형 설정을 지역으로 유지합니다.
API 생성(Create API)을 선택합니다.

이 단계에서는 {proxy+}의 프록시 리소스 경로를 생성합니다. 이는 http://petstore-demo-endpoint.execute-api.com/ 아래 백엔드 엔드포인트의 자리 표시자입니다. 예를 들어 petstore, petstore/pets, petstore/pets/{petId} 등일 수 있습니다. API Gateway는 {proxy+} 리소스 생성 시 ANY 메서드를 생성하며 런타임에 지원되는 HTTP 동사에 대한 자리 표시자 역할을 합니다.

/{proxy+} 리소스를 생성하려면

API를 선택합니다.
기본 탐색 창에서 리소스를 선택합니다.
리소스 생성을 선택합니다.
프록시 리소스를 켭니다.
리소스 경로를 /로 유지합니다.
리소스 이름에 {proxy+}을 입력합니다.
오리진 간 리소스 공유(CORS)를 꺼진 상태로 둡니다.
리소스 생성을 선택합니다.

이 단계에서는 프록시 통합을 사용하여 ANY 메서드를 백엔드 HTTP 엔드포인트와 통합합니다. 프록시 통합에서 API Gateway는 API Gateway의 개입 없이 클라이언트가 제출한 메서드 요청을 백엔드로 전달합니다.

`ANY` 메서드를 생성하려면

/{proxy+} 리소스를 선택합니다.
ANY 메서드를 선택합니다.
경고 기호 아래에서 통합 편집을 선택합니다. 통합 없이는 메서드가 있는 API를 배포할 수 없습니다.
통합 유형에서 HTTP를 선택합니다.
HTTP 프록시 통합을 켭니다.
HTTP 메서드에서 ANY를 선택합니다.
엔드포인트 URL에 http://petstore-demo-endpoint.execute-api.com/{proxy}를 입력합니다.
Save(저장)를 선택합니다.

HTTP 프록시 통합을 사용하여 API 테스트

특정 클라이언트 요청의 성공 여부는 다음 사항에 따라 달라집니다.

백엔드가 해당 백엔드 엔드포인트를 사용할 수 있도록 하고 (그러한 경우) 필수 액세스 권한을 부여한 경우.
클라이언트가 올바른 입력을 제공하는 경우.

예를 들어 여기에서 사용된 PetStore API는 /petstore 리소스를 공개하지 않습니다. 따라서 404 Resource Not Found 오류 메시지가 포함된 Cannot GET /petstore 응답이 표시됩니다.

또한 클라이언트는 결과를 올바르게 구문 분석하기 위해 백엔드의 출력 형식을 처리할 수 있어야 합니다. API Gateway는 클라이언트와 백엔드 간의 상호 작용을 원활하게 하기 위해 조정하지 않습니다.

프록시 리소스를 통해 HTTP 프록시 통합을 사용하여 PetStore 웹사이트와 통합된 API를 테스트하려면

테스트 탭을 선택합니다. 탭을 표시하려면 오른쪽 화살표 버튼을 선택해야 할 수도 있습니다.
메서드 유형에서 GET를 선택합니다.
경로의 proxy에 petstore/pets를 입력합니다.
쿼리 문자열에 type=fish를 입력합니다.
테스트를 선택합니다.

백엔드 웹 사이트가 GET /petstore/pets?type=fish 요청을 지원하므로 다음과 비슷한 성공적인 응답을 반환합니다.
```
[
  {
    "id": 1,
    "type": "fish",
    "price": 249.99
  },
  {
    "id": 2,
    "type": "fish",
    "price": 124.99
  },
  {
    "id": 3,
    "type": "fish",
    "price": 0.99
  }
]
```
GET /petstore 호출을 시도하면 404 오류 메시지와 함께 Cannot GET /petstore 응답이 표시됩니다. 백엔드가 지정된 작업을 지원하지 않기 때문입니다. GET /petstore/pets/1을 호출하면 요청이 PetStore 웹 사이트에서 지원되므로 다음 페이로드와 함께 200 OK 응답이 표시됩니다.
```
{
  "id": 1,
  "type": "dog",
  "price": 249.99
}
```

브라우저를 사용하여 API를 테스트할 수 있습니다. API를 배포하고 스테이지에 연결하여 API의 호출 URL을 생성합니다.

API를 배포하려면

Deploy API(API 배포)를 선택합니다.
스테이지에서 새 스테이지를 선택합니다.
단계 이름에 test를 입력합니다.
(선택 사항) 설명에 설명을 입력합니다.
배포를 선택합니다.

이제 클라이언트가 API를 호출할 수 있습니다.

API를 호출하려면

https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.
API를 선택합니다.
기본 탐색 창에서 스테이지를 선택합니다.
스테이지 세부 정보에서 복사 아이콘을 선택하여 API의 호출 URL을 복사합니다.

API의 호출 URL을 웹 브라우저에 입력합니다.

전체 URL은 https://abcdef123.execute-api.us-east-2.amazonaws.com/test/petstore/pets?type=fish와(과) 같아야 합니다.

브라우저가 API에 GET 요청을 보냅니다.
결과는 API Gateway 콘솔에서 테스트를 사용할 때 반환되는 결과와 같아야 합니다.

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

HTTP 통합 튜토리얼 선택

자습서: HTTP 비 프록시 통합을 통해 REST API 생성