Amazon API Gateway에서 REST API 호출 - Amazon API Gateway

Amazon API Gateway에서 REST API 호출

배포된 API를 호출하기 위해 클라이언트는 API 실행을 위한 API Gateway 구성 요소 서비스(예: execute-api)에 대한 URL 요청을 제출합니다.

기본 REST API URL의 형식은 다음과 같습니다.

https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/

여기서 {restapi_id}는 API 식별자이고, {region}은 리전이고, {stage_name}은 API 배포의 스테이지 이름입니다.

중요

API를 호출하기 전에 API Gateway에서 배포해야 합니다. 그러려면 Amazon API Gateway에서 REST API 배포의 지침을 따르세요.

API Gateway 콘솔에서 API의 호출 URL 얻기

REST API의 루트 URL은 API Gateway 콘솔의 API에 대한 단계 편집기에서 찾을 수 있습니다. 맨 위에 Invoke URL(URL 호출)로 나열됩니다. API의 루트 리소스에서 사용자 인증을 요구하지 않고 GET 메서드를 노출할 경우 URL 호출(Invoke URL) 링크를 클릭하여 메서드를 호출할 수 있습니다. API의 내보낸 OpenAPI 정의 파일에서 host 필드와 basePath 필드를 결합하여 이 루트 URL을 구성할 수도 있습니다.

API에서 익명 액세스를 허용하는 경우 적절한 호출 URL을 복사한 후 웹 브라우저의 주소 표시줄에 붙여 넣어 GET 메서드를 호출할 수 있습니다. 다른 메서드 또는 인증이 필요한 호출의 경우 페이로드를 지정하거나 요청에 서명해야 하므로 호출이 더 복잡합니다. AWS SDK 중 하나를 사용하여 HTML 페이지 뒤의 스크립트나 클라이언트 애플리케이션에서 이러한 호출을 처리할 수 있습니다.

테스트를 위해 API Gateway 콘솔에서 API Gateway의 TestInvoke 기능을 사용하여 API를 호출할 수 있습니다. 이 기능을 통해 Invoke URL을 우회하고 API를 배포하기 전에 API 테스트를 할 수 있습니다. 또는 Postman 애플리케이션을 사용하여 스크립트 또는 클라이언트를 작성하지 않고 성공적으로 배포된 API를 테스트할 수 있습니다.

참고

호출 URL의 쿼리 문자열 파라미터 값은 %%를 포함할 수 없습니다.