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 식별자, 지역은 지역, stage_name은 API 배포의 단계 이름입니다. AWS

중요

API를 호출하기 전에 API Gateway에서 배포해야 합니다. API 배포에 대한 지침은 을 참조하십시오. Amazon API Gateway에서 REST API 배포

API의 호출 URL 가져오기

콘솔 AWS CLI, 또는 내보낸 OpenAPI 정의를 사용하여 API의 호출 URL을 가져올 수 있습니다.

콘솔을 사용하여 API의 호출 URL 가져오기

다음 절차는 REST API 콘솔에서 API의 호출 URL을 가져오는 방법을 보여줍니다.

REST API 콘솔을 사용하여 API의 호출 URL을 가져오려면
  1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

  2. 배포된 API를 선택합니다.

  3. 기본 탐색 창에서 스테이지를 선택합니다.

  4. 스테이지 세부 정보에서 복사 아이콘을 선택하여 API의 호출 URL을 복사합니다.

    이 URL은 API의 루트 리소스용입니다.

    
                REST API를 생성하면 콘솔에 API의 호출 URL이 표시됩니다.
  5. API의 다른 리소스에 대한 API의 호출 URL을 가져오려면 보조 탐색 창 아래의 단계를 확장한 다음 메서드를 선택합니다.

  6. 복사 아이콘을 선택하여 API의 리소스 수준 호출 URL을 복사합니다.

    
              보조 탐색 창 아래에서 단계를 확장하면 콘솔에 리소스 수준 API의 호출 URL이 표시됩니다.

를 사용하여 API의 호출 URL 가져오기 AWS CLI

다음 절차는 를 사용하여 API의 호출 URL을 얻는 방법을 보여줍니다. AWS CLI

를 사용하여 API의 호출 URL을 얻으려면 AWS CLI
  1. 다음 명령을 사용하여 을 (를) 가져올 수 있습니다rest-api-id. 이 명령은 해당 지역의 모든 rest-api-id 값을 반환합니다. 자세한 내용은 을 참조하십시오 get-rest-apis.

    aws apigateway get-rest-apis
  2. 예제를 rest-api-id y로 바꾸고rest-api-id, 예제 {stage-name} 을 {stage-name} 으로 바꾸고, {region} 을 해당 지역으로 바꾸십시오.

    https://{restapi_id}.execute-api.{region}.amazonaws.com/{stage_name}/
내보낸 API의 OpenAPI 정의 파일을 사용하여 API의 호출 URL 가져오기

내보낸 API의 OpenAPI 정의 파일의 hostbasePath 필드를 결합하여 루트 URL을 생성할 수도 있습니다. API를 내보내는 방법에 대한 지침은 을 참조하십시오API Gateway에서 REST API 내보내기.

API 호출

브라우저, curl 또는 Postman과 같은 기타 애플리케이션을 사용하여 배포된 API를 호출할 수 있습니다.

또한 API Gateway 콘솔을 사용하여 API 호출을 테스트할 수 있습니다. 테스트에서는 API Gateway의 TestInvoke 기능을 사용하므로 API를 배포하기 전에 API를 테스트할 수 있습니다. 자세한 설명은 API Gateway 콘솔을 사용하여 REST API 메서드 테스트 섹션을 참조하세요.

참고

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

웹 브라우저를 사용하여 API 호출

API에서 익명 액세스를 허용하는 경우 모든 웹 브라우저를 사용하여 모든 메서드를 호출할 수 있습니다. GET 브라우저의 주소 표시줄에 전체 호출 URL을 입력합니다.

다른 방법이나 인증이 필요한 호출의 경우 페이로드를 지정하거나 요청에 서명해야 합니다. HTML 페이지 뒤의 스크립트나 SDK 중 하나를 사용하는 클라이언트 애플리케이션에서 이러한 작업을 처리할 수 있습니다. AWS

curl을 사용하여 API 호출

터미널에서 curl과 같은 도구를 사용하여 API를 호출할 수 있습니다. 다음 예제 curl 명령은 API prod 스테이지의 getUsers 리소스에서 GET 메서드를 호출합니다.

Linux or Macintosh
curl -X GET 'https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers'
Windows
curl -X GET "https://b123abcde4.execute-api.us-west-2.amazonaws.com/prod/getUsers"