GSP872

개요

API 게이트웨이를 사용하면 서비스 구현과 관계없이 모든 서비스에서 명확하게 정의되고 일관된 REST API를 통해 서비스에 안전하게 액세스할 수 있습니다. 일관된 API를 사용하여 다음 이점을 활용할 수 있습니다.

• 앱 개발자가 서비스를 쉽게 사용할 수 있습니다.
• 공개 API에 영향을 미치지 않고 백엔드 서비스 구현을 변경할 수 있습니다.
• Google Cloud에 내장된 확장, 모니터링, 보안 기능을 활용할 수 있습니다.

이 실습에서는 API 게이트웨이에 API를 배포하여 백엔드 서비스 트래픽을 보호합니다.

설정 및 요건

실습 시작 버튼을 클릭하기 전에

다음 안내를 확인하세요. 실습에는 시간 제한이 있으며 일시중지할 수 없습니다. 실습 시작을 클릭하면 타이머가 시작됩니다. 이 타이머는 Google Cloud 리소스를 사용할 수 있는 시간이 얼마나 남았는지를 표시합니다.

실무형 실습을 통해 시뮬레이션이나 데모 환경이 아닌 실제 클라우드 환경에서 실습 활동을 진행할 수 있습니다. 실습 시간 동안 Google Cloud에 로그인하고 액세스하는 데 사용할 수 있는 새로운 임시 사용자 인증 정보가 제공됩니다.

이 실습을 완료하려면 다음을 준비해야 합니다.

• 표준 인터넷 브라우저 액세스 권한(Chrome 브라우저 권장)

참고: 이 실습을 실행하려면 시크릿 모드(권장) 또는 시크릿 브라우저 창을 사용하세요. 개인 계정과 학습자 계정 간의 충돌로 개인 계정에 추가 요금이 발생하는 일을 방지해 줍니다.

• 실습을 완료하기에 충분한 시간(실습을 시작하고 나면 일시중지할 수 없음)

참고: 이 실습에는 학습자 계정만 사용하세요. 다른 Google Cloud 계정을 사용하는 경우 해당 계정에 비용이 청구될 수 있습니다.

실습을 시작하고 Google Cloud 콘솔에 로그인하는 방법

1. 실습 시작 버튼을 클릭합니다. 실습 비용을 결제해야 하는 경우 결제 수단을 선택할 수 있는 대화상자가 열립니다. 왼쪽에는 다음과 같은 항목이 포함된 실습 세부정보 창이 있습니다.

   • Google Cloud 콘솔 열기 버튼
   • 남은 시간
   • 이 실습에 사용해야 하는 임시 사용자 인증 정보
   • 필요한 경우 실습 진행을 위한 기타 정보

2. Google Cloud 콘솔 열기를 클릭합니다(Chrome 브라우저를 실행 중인 경우 마우스 오른쪽 버튼으로 클릭하고 시크릿 창에서 링크 열기를 선택합니다).

   실습에서 리소스가 가동되면 다른 탭이 열리고 로그인 페이지가 표시됩니다.

   팁: 두 개의 탭을 각각 별도의 창으로 나란히 정렬하세요.

   참고: 계정 선택 대화상자가 표시되면 다른 계정 사용을 클릭합니다.

3. 필요한 경우 아래의 사용자 이름을 복사하여 로그인 대화상자에 붙여넣습니다.

   {{{user_0.username | "Username"}}}

   실습 세부정보 창에서도 사용자 이름을 확인할 수 있습니다.

4. 다음을 클릭합니다.

5. 아래의 비밀번호를 복사하여 시작하기 대화상자에 붙여넣습니다.

   {{{user_0.password | "Password"}}}

   실습 세부정보 창에서도 비밀번호를 확인할 수 있습니다.

6. 다음을 클릭합니다.

   중요: 실습에서 제공하는 사용자 인증 정보를 사용해야 합니다. Google Cloud 계정 사용자 인증 정보를 사용하지 마세요. 참고: 이 실습에 자신의 Google Cloud 계정을 사용하면 추가 요금이 발생할 수 있습니다.

7. 이후에 표시되는 페이지를 클릭하여 넘깁니다.

   • 이용약관에 동의합니다.
   • 임시 계정이므로 복구 옵션이나 2단계 인증을 추가하지 않습니다.
   • 무료 체험판을 신청하지 않습니다.

잠시 후 Google Cloud 콘솔이 이 탭에서 열립니다.

참고: Google Cloud 제품 및 서비스에 액세스하려면 탐색 메뉴를 클릭하거나 검색창에 제품 또는 서비스 이름을 입력합니다.

Cloud Shell 활성화

Cloud Shell은 다양한 개발 도구가 탑재된 가상 머신으로, 5GB의 영구 홈 디렉터리를 제공하며 Google Cloud에서 실행됩니다. Cloud Shell을 사용하면 명령줄을 통해 Google Cloud 리소스에 액세스할 수 있습니다.

1. Google Cloud 콘솔 상단에서 Cloud Shell 활성화 를 클릭합니다.

2. 다음 창을 클릭합니다.

   • Cloud Shell 정보 창을 통해 계속 진행합니다.
   • 사용자 인증 정보를 사용하여 Google Cloud API를 호출할 수 있도록 Cloud Shell을 승인합니다.

연결되면 사용자 인증이 이미 처리된 것이며 프로젝트가 학습자의 PROJECT_ID, (으)로 설정됩니다. 출력에 이 세션의 PROJECT_ID를 선언하는 줄이 포함됩니다.

Your Cloud Platform project in this session is set to {{{project_0.project_id | "PROJECT_ID"}}}

gcloud는 Google Cloud의 명령줄 도구입니다. Cloud Shell에 사전 설치되어 있으며 명령줄 자동 완성을 지원합니다.

3. (선택사항) 다음 명령어를 사용하여 활성 계정 이름 목록을 표시할 수 있습니다.

gcloud auth list

4. 승인을 클릭합니다.

출력:

ACTIVE: * ACCOUNT: {{{user_0.username | "ACCOUNT"}}} To set the active account, run: $ gcloud config set account `ACCOUNT`

5. (선택사항) 다음 명령어를 사용하여 프로젝트 ID 목록을 표시할 수 있습니다.

gcloud config list project

출력:

[core] project = {{{project_0.project_id | "PROJECT_ID"}}} 참고: gcloud 전체 문서는 Google Cloud에서 gcloud CLI 개요 가이드를 참고하세요.

리전 설정

이 실습을 위한 프로젝트 리전을 설정합니다.

gcloud config set compute/region {{{project_0.default_region | "REGION"}}}

필요한 API 사용 설정

1. Cloud 콘솔의 탐색 메뉴()에서 API 및 서비스 > 라이브러리를 클릭합니다.

2. 검색창에 'api gateway'를 입력한 다음 API Gateway API 타일을 선택합니다.

3. 이제 다음 화면에서 사용 설정 버튼을 클릭합니다.

작업 1. API 백엔드 배포

API 게이트웨이는 배포된 백엔드 서비스 앞에 설정되어 모든 수신 요청을 처리합니다. 이 실습에서는 API 게이트웨이가 수신 호출을 아래 표시된 함수를 포함하는 helloGET이라는 Cloud 함수 백엔드로 라우팅합니다.

/** * HTTP Cloud Function. * This function is exported by index.js, and is executed when * you make an HTTP request to the deployed function's endpoint. * * @param {Object} req Cloud Function request context. * More info: https://expressjs.com/en/api.html#req * @param {Object} res Cloud Function response context. * More info: https://expressjs.com/en/api.html#res */ exports.helloGET = (req, res) => { res.send('Hello World!'); };

1. Cloud 콘솔에서 Cloud 함수 샘플 저장소를 클론합니다.

git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

2. Cloud Functions 샘플 코드가 있는 디렉터리로 변경합니다.

cd nodejs-docs-samples/functions/helloworld/helloworldGet

3. HTTP 트리거를 사용하여 함수를 배포하려면 함수가 포함된 디렉터리에서 다음 명령어를 실행합니다.

gcloud functions deploy helloGET --runtime nodejs20 --trigger-http --allow-unauthenticated --region {{{project_0.default_region | "REGION"}}}

• 메시지가 표시되면 Y를 입력하여 API를 사용 설정합니다.

참고: 사용자 인증 정보로 gcloud 명령어를 허용하라는 요청이 표시되면 승인을 클릭합니다. Cloud 함수가 배포되는 데 몇 분 정도 걸립니다. 작업이 완료될 때까지 기다린 후 계속 진행합니다. 경고: IamPermissionDeniedException 오류가 발생하면 위의 명령어를 다시 실행합니다.

내 진행 상황 확인하기를 클릭하여 목표를 확인합니다. API 백엔드 배포

작업 2. API 백엔드 테스트

1. 함수 배포가 완료되면 httpsTrigger의 url 속성을 기록하거나 다음 명령어를 사용하여 찾을 수 있습니다.

gcloud functions describe helloGET --region {{{project_0.default_region | "REGION"}}}

출력은 아래 URL과 비슷하게 표시되며, PROJECT_ID는 프로젝트에 고유한 값입니다.

2. PROJECT_ID를 변수로 설정합니다.

export PROJECT_ID={{{project_0.project_id}}}

3. URL을 방문하여 Cloud 함수를 호출합니다. Hello World! 메시지가 응답으로 표시됩니다.

curl -v https://{{{project_0.default_region | "REGION"}}}-{{{project_0.project_id | "PROJECT_ID"}}}.cloudfunctions.net/helloGET

내 진행 상황 확인하기를 클릭하여 목표를 확인합니다. API 백엔드 테스트

API 정의 만들기

API 게이트웨이는 API 정의를 사용하여 호출을 백엔드 서비스로 라우팅합니다. 특수한 주석이 포함된 OpenAPI 사양을 사용해서 원하는 API 게이트웨이 동작을 정의할 수 있습니다. 이 빠른 시작의 OpenAPI 사양에는 Cloud 함수 백엔드에 대한 라우팅 안내가 포함되어 있습니다.

1. Cloud Shell에서 홈 디렉터리로 다시 이동합니다.

cd ~

2. openapi2-functions.yaml이라는 새 파일을 만듭니다.

touch openapi2-functions.yaml

3. 아래 표시된 OpenAPI 사양의 콘텐츠를 복사해서 새로 생성된 파일에 붙여넣습니다.

# openapi2-functions.yaml swagger: '2.0' info: title: API_ID description description: Sample API on API Gateway with a Google Cloud Functions backend version: 1.0.0 schemes: - https produces: - application/json paths: /hello: get: summary: Greet a user operationId: hello x-google-backend: address: https://{{{project_0.default_region | "REGION"}}}-{{{project_0.project_id | "PROJECT_ID"}}}.cloudfunctions.net/helloGET responses: '200': description: A successful response schema: type: string

4. 다음 환경 변수를 설정합니다.

export API_ID="hello-world-$(cat /dev/urandom | tr -dc 'a-z' | fold -w ${1:-8} | head -n 1)"

5. 다음 명령어를 실행하여 OpenAPI 사양 파일의 마지막 단계에서 설정한 변수를 바꿉니다.

sed -i "s/API_ID/${API_ID}/g" openapi2-functions.yaml sed -i "s/PROJECT_ID/$PROJECT_ID/g" openapi2-functions.yaml

작업 3. 게이트웨이 만들기

이제 API 게이트웨이에서 게이트웨이를 만들고 배포할 준비가 완료되었습니다.

1. 상단 검색창에 API 게이트웨이를 입력하고 표시되는 옵션에서 선택합니다.

2. 게이트웨이 만들기를 클릭합니다. 그런 다음 API 섹션에서 다음을 수행합니다.

• API 선택 입력이 새 API 만들기로 설정되어 있는지 확인합니다.
• 표시 이름에 Hello World API를 입력합니다.
• API ID의 경우 다음 명령어를 실행하여 API ID를 다시 가져온 다음 API ID 필드에 입력합니다.

export API_ID="hello-world-$(cat /dev/urandom | tr -dc 'a-z' | fold -w ${1:-8} | head -n 1)" echo $API_ID

3. API 구성 섹션에서 다음을 수행합니다.

• 구성 선택 입력이 새 API 구성 만들기로 설정되어 있는지 확인합니다.
• 이전에 만든 openapi2-functions.yaml 파일을 업로드하려면 다음 단계를 따르세요.

4. Cloud Shell에서 다음 명령어를 실행합니다.

cloudshell download $HOME/openapi2-functions.yaml

5. 다운로드를 클릭합니다.

참고: 이제 openapi2-functions.yaml 파일이 로컬 머신에 다운로드됩니다.

6. 찾아보기를 선택하고 브라우저의 다운로드 위치에서 파일을 선택합니다.

• 표시 이름 필드에 Hello World Config를 입력합니다.
• 서비스 계정 선택 입력이 Compute Engine 기본 서비스 계정으로 설정되어 있는지 확인합니다.

7. 게이트웨이 세부정보 섹션에서 다음을 수행합니다.

• 표시 이름 필드에 Hello Gateway를 입력합니다.
• 위치 드롭다운을 (으)로 설정합니다.

8. 게이트웨이 만들기를 클릭합니다.

참고: 게이트웨이 만들기 작업이 완료되는 데 10분 정도 걸립니다. 만들기 및 배포 프로세스 상태를 확인하려면 아래 이미지에 표시된 것처럼 기본 탐색 메뉴에서 알림 아이콘을 클릭하여 상태 알림을 표시할 수 있습니다. 계속하기 전에 아이콘 상태 옆에 녹색 체크표시가 있는지 확인하세요.

내 진행 상황 확인하기를 클릭하여 목표를 확인합니다. 게이트웨이 만들기

API 배포 테스트

이제 게이트웨이 배포 후 생성된 URL을 사용해서 API로 요청을 보낼 수 있습니다.

1. Cloud Shell에서 다음 명령어를 입력하여 API 게이트웨이에서 호스팅하는 새로 생성된 API의 GATEWAY_URL을 검색합니다.

export GATEWAY_URL=$(gcloud api-gateway gateways describe hello-gateway --location {{{project_0.default_region | "REGION"}}} --format json | jq -r .defaultHostname)

2. 다음 명령어를 실행하여 GATEWAY_URL 환경 변수가 설정되었는지 확인합니다.

echo $GATEWAY_URL

설정되지 않은 경우 API 게이트웨이가 배포될 때까지 더 오래 기다려야 합니다.

3. 다음 curl 명령어를 실행하고 반환된 응답이 Hello World!인지 확인합니다.

curl -s -w "\n" https://$GATEWAY_URL/hello

작업 4. API 키를 사용하여 액세스 보호

API 백엔드 액세스를 보호하기 위해, 프로젝트와 연결된 API 키를 생성하고 이 키에 API 호출 액세스 권한을 부여할 수 있습니다. API 키를 만들려면 다음 단계를 따르세요.

1. Google Cloud 콘솔에서 API 및 서비스 > 사용자 인증 정보로 이동합니다.
2. 사용자 인증 정보 만들기를 선택한 후 드롭다운 메뉴에서 API 키를 선택합니다. API 키 생성 대화상자에 새로 생성된 키가 표시됩니다.

내 진행 상황 확인하기를 클릭하여 목표를 확인합니다. API 키를 사용하여 액세스 보호

3. 대화상자에서 API 키를 복사한 다음 닫기를 클릭합니다.

4. 다음 명령어를 실행하여 Cloud Shell에 API 키 값을 저장합니다.

export API_KEY=REPLACE_WITH_COPIED_API_KEY

이제 서비스에 대해 API 키 지원을 사용 설정합니다.

1. Cloud Shell에서 다음 명령어를 사용하여 방금 만든 관리형 서비스의 이름을 가져옵니다.

MANAGED_SERVICE=$(gcloud api-gateway apis list --format json | jq -r .[0].managedService | cut -d'/' -f6) echo $MANAGED_SERVICE

2. 그런 다음 방금 만든 API의 관리형 서비스 이름을 사용해 다음 명령어를 실행하여 서비스에 대한 API 키 지원을 사용 설정합니다.

gcloud services enable $MANAGED_SERVICE

API 키 보안을 활용하도록 OpenAPI 사양 수정

이 섹션에서는 배포된 API의 API 구성을 수정하여 모든 트래픽에 API 키 검증 보안 정책을 적용합니다.

1. 아래와 같이 security 유형과 securityDefinitions 섹션을 openapi2-functions2.yaml이라는 새 파일에 추가합니다.

touch openapi2-functions2.yaml

2. 아래 표시된 OpenAPI 사양의 콘텐츠를 복사해서 새로 생성된 파일에 붙여넣습니다.

# openapi2-functions.yaml swagger: '2.0' info: title: API_ID description description: Sample API on API Gateway with a Google Cloud Functions backend version: 1.0.0 schemes: - https produces: - application/json paths: /hello: get: summary: Greet a user operationId: hello x-google-backend: address: https://{{{project_0.default_region | "REGION"}}}-{{{project_0.project_id | "PROJECT_ID"}}}.cloudfunctions.net/helloGET security: - api_key: [] responses: '200': description: A successful response schema: type: string securityDefinitions: api_key: type: "apiKey" name: "key" in: "query"

3. 다음 명령어를 실행하여 OpenAPI 사양 파일의 마지막 단계에서 설정한 변수를 바꿉니다.

sed -i "s/API_ID/${API_ID}/g" openapi2-functions2.yaml sed -i "s/PROJECT_ID/$PROJECT_ID/g" openapi2-functions2.yaml

4. 업데이트된 API 사양 파일을 다운로드합니다. 다음 단계에서 이 파일을 사용하여 게이트웨이 구성을 업데이트합니다.

cloudshell download $HOME/openapi2-functions2.yaml

5. 다운로드를 클릭합니다.

작업 5. 새 API 구성을 만들고 기존 게이트웨이에 배포

1. Cloud 콘솔에서 API 게이트웨이 페이지를 엽니다. (탐색 메뉴 > API 게이트웨이를 클릭합니다.)
2. 목록에서 세부정보를 보려는 API를 선택합니다.
3. 게이트웨이 탭을 선택합니다.
4. 사용 가능한 게이트웨이 목록에서 Hello Gateway를 선택합니다.
5. 게이트웨이 페이지 상단의 수정을 클릭합니다.
6. API 구성에서 드롭다운을 새 API 구성 만들기로 변경합니다.
7. API 사양 업로드 입력 상자에서 찾아보기를 클릭하고 openapi2-functions2.yaml 파일을 선택합니다.
8. 표시 이름에 Hello Config를 입력합니다.
9. 서비스 계정 선택에서 Qwiklabs 사용자 서비스 계정을 선택합니다.
10. 업데이트를 클릭합니다.

참고: 게이트웨이 업데이트 작업이 완료되는 데 몇 분 정도 걸릴 수 있습니다. 만들기 및 배포 프로세스 상태를 확인하려면 아래 이미지에 표시된 것처럼 기본 탐색 메뉴에서 알림 아이콘을 클릭하여 상태 알림을 표시할 수 있습니다. 계속하기 전에 아이콘 상태 옆에 녹색 체크표시가 있는지 확인하세요.

내 진행 상황 확인하기를 클릭하여 목표를 확인합니다. 새 API 구성을 만들고 기존 게이트웨이에 배포

작업 6. API 키를 사용하여 호출 테스트

1. API 키를 사용하여 테스트하려면 다음 명령어를 실행합니다.

export GATEWAY_URL=$(gcloud api-gateway gateways describe hello-gateway --location {{{project_0.default_region | "REGION"}}} --format json | jq -r .defaultHostname) curl -sL $GATEWAY_URL/hello

curl 호출에 API 키가 제공되지 않았으므로 다음과 비슷한 오류 응답이 표시됩니다. UNAUTHENTICATED:Method doesn't allow unregistered callers (callers without established identity). Please use API Key or other form of API consumer identity to call this API.

2. key 쿼리 파라미터로 다음 curl 명령어를 실행하고 이전에 만든 API 키를 사용하여 API를 호출합니다.

curl -sL -w "\n" $GATEWAY_URL/hello?key=$API_KEY

API_KEY 환경 변수가 설정되어 있지 않은 경우 왼쪽 메뉴에서 API 및 서비스 > 사용자 인증 정보로 이동하여 API 키를 가져올 수 있습니다. 키는 API 키 섹션에서 확인할 수 있습니다.

이제 API에서 반환된 응답은 Hello World!여야 합니다.

참고: 원하는 결과를 얻으려면 이 명령어를 두 번 이상 실행해야 할 수 있습니다.

내 진행 상황 확인하기를 클릭하여 목표를 확인합니다. API 키를 사용한 호출 테스트

수고하셨습니다.

API 게이트웨이를 사용해 API 백엔드를 보호했습니다. 이제 추가 API 키를 생성하여 새 API 클라이언트 온보딩을 시작할 수 있습니다.

Google Cloud 교육 및 자격증

Google Cloud 기술을 최대한 활용하는 데 도움이 됩니다. Google 강의에는 빠른 습득과 지속적인 학습을 지원하는 기술적인 지식과 권장사항이 포함되어 있습니다. 기초에서 고급까지 수준별 학습을 제공하며 바쁜 일정에 알맞은 주문형, 실시간, 가상 옵션이 포함되어 있습니다. 인증은 Google Cloud 기술에 대한 역량과 전문성을 검증하고 입증하는 데 도움이 됩니다.

설명서 최종 업데이트: 2024년 10월 9일

실습 최종 테스트: 2024년 10월 9일

Copyright 2025 Google LLC. All rights reserved. Google 및 Google 로고는 Google LLC의 상표입니다. 기타 모든 회사명 및 제품명은 해당 업체의 상표일 수 있습니다.