App Engine 표준 환경에서 Endpoints 시작하기

이 페이지에서는 App Engine의 Cloud Endpoints를 설정하는 방법을 보여줍니다. Endpoints는 ESP(Extensible Service Proxy)API 게이트웨이로 사용합니다. App Engine에 API 관리를 제공하려면 사전 빌드된 ESP 컨테이너를 Cloud Run에 배포합니다. 그런 다음 ESP가 앱을 호출할 수 있도록 IAP(Identity-Aware Proxy)를 사용하여 앱을 보호합니다. 이렇게 설정하면 ESP는 앱에 대한 모든 요청을 가로채고 앱을 호출하기 전에 인증 등의 필요한 검사를 수행한 후에 앱이 응답하면 ESP는 원격 분석을 수집하고 보고합니다. 앱의 측정항목은 Google Cloud Console의 Endpoints > 서비스 페이지에서 확인할 수 있습니다.

Cloud Endpoints 개요는 Endpoints 정보Endpoints 아키텍처를 참조하세요.

작업 목록

다음 작업 목록을 사용하여 가이드를 진행하세요. Endpoints에서 앱을 관리하려면 다음 작업이 모두 필요합니다.

  1. Google Cloud 프로젝트를 만들고 자체 App Engine을 배포하지 않은 경우 샘플 앱을 배포합니다. 시작 전 유의사항을 참조하세요.
  2. 앱을 보호하도록 IAP를 구성합니다. IAP 구성을 참조하세요.
  3. ESP 컨테이너를 Cloud Run에 배포합니다. ESP 배포를 참조하세요.
  4. API를 설명하는 OpenAPI 문서를 만들고 App Engine에 대한 경로를 구성합니다. Endpoints 구성을 참조하세요.
  5. OpenAPI 문서를 배포하여 관리형 서비스를 만듭니다. Endpoints 구성 배포를 참조하세요.
  6. 서비스의 구성을 찾을 수 있도록 ESP를 구성합니다. ESP 구성을 참조하세요.
  7. 앱을 호출합니다. API에 요청 보내기를 참조하세요.
  8. 앱 활동을 추적합니다. API 활동 추적을 참조하세요.
  9. Google Cloud 계정에 요금이 청구되지 않도록 합니다. 삭제를 참조하세요.

시작하기 전에

App Engine의 Endpoints는 알파 버전이므로 다음과 같이 하는 것이 좋습니다.

  • ESP 컨테이너를 Cloud Run에 배포할 때 사용할 새 Google Cloud 프로젝트를 만듭니다.

  • App Engine에 대한 새 프로젝트를 만들거나 기존 프로젝트를 선택합니다.

설정하려면 다음 안내를 따르세요.

  1. Cloud Console에서 리소스 관리 페이지로 이동하여 프로젝트를 만듭니다.

    리소스 관리 페이지로 이동

  2. 프로젝트에 결제가 사용 설정되어 있는지 확인하세요.

    결제 사용 설정 방법 알아보기

  3. 나중에 필요하므로 프로젝트 ID를 기록합니다. 이 페이지의 나머지 부분에서는 프로젝트 ID를 ESP_PROJECT_ID라고 합니다.

  4. 나중에 필요하므로 프로젝트 번호를 기록합니다. 이 페이지의 나머지 부분에서는 프로젝트 번호를 ESP_PROJECT_NUMBER라고 합니다.

  5. Cloud SDK를 다운로드하여 설치합니다.

    Cloud SDK 다운로드

  6. 자체 App Engine을 배포하지 않은 경우, 사용자 언어에 해당하는 App Engine 빠른 시작의 단계를 따라 gcloud 명령줄 도구를 사용하여 Google Cloud 프로젝트를 선택하거나 만들고 샘플 앱을 배포합니다. 앱이 배포되는 리전과 프로젝트 ID를 기록해 둡니다. 이 페이지의 나머지 부분에서는 프로젝트 ID를 APP_PROJECT_ID라고 합니다.

IAP를 구성하여 앱 보안

App Engine 앱 보안을 위해 IAP(Identity-Aware Proxy)를 사용하여 요청이 인증되었는지 확인해야 합니다.

IAP 사용 설정 단계에 따라 애플리케이션에 로그인할 수 있는지 확인합니다.

또한 OAuth 클라이언트를 구성할 때 이 빠른 시작에서 IAP_CLIENT_ID라고 하는 OAuth client_id를 기록해 둡니다.

ESP 배포

ESP 컨테이너를 Cloud Run에 배포하려면 다음 안내를 따르세요.

  1. Cloud SDK가 데이터와 서비스에 액세스하도록 승인되었는지 확인합니다.
    1. 로그인합니다.
      gcloud auth login
    2. 새 브라우저 탭이 열리면 ESP를 Cloud Run에 배포하기 위해 만든 Google Cloud 프로젝트에서 편집자 또는 소유자 역할이 있는 계정을 선택합니다.
  2. 리전을 설정합니다. 현재 Cloud Run에는 us-central1만 지원됩니다.
    gcloud config set run/region us-central1
  3. ESP를 Cloud Run에 배포합니다. CLOUD_RUN_SERVICE_NAME을 서비스에 사용할 이름으로 바꿉니다.
    gcloud beta run deploy CLOUD_RUN_SERVICE_NAME \
        --image="gcr.io/endpoints-release/endpoints-runtime-serverless:1.30.0" \
        --allow-unauthenticated \
        --project=ESP_PROJECT_ID
    

    명령어가 성공적으로 실행 완료되면 다음과 유사한 메시지가 표시됩니다.

    Service [gateway] revision [gateway-00001] has been deployed and is serving
    traffic at https://gateway-12345-uc.a.run.app

    앞의 예시에서 gateway는 Cloud Run 서비스의 이름입니다.

  4. URL의 호스트 이름을 기록해 둡니다. OpenAPI 문서의 host 필드에 호스트 이름을 지정합니다.
  5. Cloud Run 서비스가 인터넷에 공개됩니다. 인증 기능을 추가하려면 Endpoints에서 지원하는 인증 방법 중 하나를 사용하는 것이 좋습니다.

Endpoints 구성

앱의 노출 영역과 인증 요구사항을 설명하는 OpenAPI Specification v2.0 기반의 OpenAPI 문서가 있어야 합니다. ESP가 앱을 호출하는데 필요한 정보를 갖도록 각 앱의 URL을 포함하는 Google 전용 필드도 추가해야 합니다. OpenAPI를 처음 사용하는 경우 OpenAPI 개요에서 자세한 내용을 참조하세요.

  1. openapi-appengine.yaml이라는 텍스트 파일을 만듭니다. 편의상 이 페이지에서는 OpenAPI 문서를 이 파일 이름으로 지칭하지만 원하면 다른 이름을 지정할 수 있습니다.
  2. 각 앱은 openapi-appengine.yaml 파일의 paths 섹션에 표시됩니다. 예를 들면 다음과 같습니다.
      swagger: '2.0'
      info:
        title: Cloud Endpoints + App Engine
        description: Sample API on Cloud Endpoints with an App Engine backend
        version: 1.0.0
      host: HOST
      schemes:
        - https
      produces:
        - application/json
      x-google-backend:
        address: https://APP_PROJECT_ID.REGION.r.appspot.com
        jwt_audience: IAP_CLIENT_ID
      paths:
        /hello:
          get:
            summary: Greet a user
            operationId: hello
            responses:
              '200':
                description: A successful response
                schema:
                  type: string
    
  3. x-google-backend 섹션의 address 필드에서 APP_PROJECT_ID를 Google Cloud 프로젝트 ID로 바꾸고 REGION을 App Engine을 배포한 GCP 리전으로, IAP_CLIENT_ID를 IAP를 설정할 때 만든 OAuth 클라이언트 ID로 바꿉니다.
  4. host 필드에 Cloud Run에서 ESP용으로 만든 제공 URL의 호스트 이름을 추가합니다. https:// 프로토콜 식별자는 포함하지 않습니다. 예를 들면 다음과 같습니다.
    swagger: '2.0'
      info:
        title: Cloud Endpoints + App Engine
        description: Sample API on Cloud Endpoints with an App Engine backend
        version: 1.0.0
      host: gateway-12345-uc.a.run.app
    

    Endpoints에서는 사용자가 host 필드에서 구성한 이름을 서비스 이름으로 사용합니다.

  5. OpenAPI 문서를 저장합니다.

Endpoints에 필요한 OpenAPI 문서의 필드에 대한 자세한 내용은 Endpoints 구성을 참조하세요.

Endpoints 구성 배포

Endpoints 구성을 배포하려면 gcloud endpoints services deploy 명령어를 사용합니다. 이 명령어는 Service Management를 사용하여 관리형 서비스를 만듭니다.

Endpoints 구성을 배포하려면 다음 안내를 따르세요.

  1. OpenAPI 문서가 포함된 디렉토리에 있는지 확인합니다.

  2. 구성을 업로드하고 관리형 서비스를 만듭니다.

    gcloud endpoints services deploy openapi-appengine.yaml \
      --project ESP_PROJECT_ID
    

    그러면 openapi-appengine.yaml 파일의 host 필드에 지정한 이름으로 새 Endpoints 서비스가 생성됩니다. 이 서비스는 OpenAPI 문서에 따라 구성됩니다.

서비스 생성 및 구성 시 Service Management는 터미널에 정보를 출력합니다. 배포가 완료되면 다음과 유사한 메시지가 표시됩니다.

Service Configuration [2019-02-01-r0] uploaded for service [gateway-12345-uc.a.run.app]

앞의 예시에서 2019-02-01-r0은 서비스 구성 ID이며 gateway-12345-uc.a.run.app은 Endpoints 서비스 이름입니다. 서비스 구성 ID는 날짜 스탬프 뒤에 버전 번호가 있는 형태입니다. 당일에 openapi-appengine.yaml을 다시 배포하면 서비스 구성 ID에서 버전 번호가 증가합니다. Cloud Console의 Endpoints > 서비스 페이지에서 서비스 구성과 배포 기록을 볼 수 있습니다.

오류 메시지가 나타나면 Endpoints 구성 배포 문제해결을 참조하세요.

필수 서비스 확인

Endpoints와 ESP를 사용하려면 최소한 다음 Google 서비스를 사용 설정해야 합니다.
이름 제목
servicemanagement.googleapis.com Service Management API
servicecontrol.googleapis.com Service Control API
endpoints.googleapis.com Google Cloud Endpoints

대부분의 경우 gcloud endpoints services deploy 명령어를 사용하여 이러한 필수 서비스를 사용 설정할 수 있습니다. 하지만 다음과 같은 경우에는 gcloud 명령어가 성공적으로 완료되더라도 필수 서비스가 사용 설정되지 않습니다.

  • Terraform과 같은 타사 애플리케이션을 사용하고 이러한 서비스를 포함하지 않은 경우

  • 이러한 서비스가 명시적으로 중지된 기존 Google Cloud 프로젝트에 Endpoints 구성을 배포한 경우

다음 명령어를 사용하여 필수 서비스가 사용 설정되어 있는지 확인합니다.

gcloud services list

필수 서비스가 나열되지 않으면 서비스를 사용 설정하세요.

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Endpoints 서비스도 사용 설정해야 합니다.

gcloud services enable ENDPOINTS_SERVICE_NAME

ENDPOINTS_SERVICE_NAME을 확인하려면 다음 중 하나를 수행합니다.

  • Endpoints 구성을 배포한 후 Cloud Console의 Endpoints 페이지로 이동합니다. 가능한 ENDPOINTS_SERVICE_NAME 목록이 서비스 이름 열 아래에 표시됩니다.

  • OpenAPI의 경우 ENDPOINTS_SERVICE_NAME은 OpenAPI 사양의 host 필드에 지정한 항목입니다. gRPC의 경우 ENDPOINTS_SERVICE_NAME은 gRPC 엔드포인트 구성의 name 필드에 지정한 항목입니다.

gcloud 명령어에 대한 자세한 내용은 gcloud 서비스를 참조하세요.

ESP 구성

Endpoints 서비스의 구성을 찾을 수 있도록 ESP를 구성합니다. 그런 다음 ESP에 IAP 보안 앱을 호출할 수 있는 Cloud IAM 권한을 부여합니다.

ESP를 구성하려면 다음 안내를 따르세요.

  1. ESP가 Endpoints 구성을 찾아서 로드할 수 있도록 Endpoints 서비스 이름을 설정합니다. 다음 명령어 안내를 따르세요.

    • YOUR_SERVICE_NAME을 Endpoints 서비스 이름으로 바꿉니다. OpenAPI 문서의 host 필드에 지정한 이름입니다.
    • CLOUD_RUN_SERVICE_NAME을 Cloud Run 서비스 이름으로 바꿉니다.
    gcloud beta run services update CLOUD_RUN_SERVICE_NAME \
       --set-env-vars ENDPOINTS_SERVICE_NAME=YOUR_SERVICE_NAME \
       --project ESP_PROJECT_ID
    
  2. CORS 사용 설정과 같은 ESP 시작 옵션을 추가로 사용하도록 Endpoints를 구성하려는 경우 ESP_ARGS 환경 변수에서 인수를 전달하면 됩니다.

    gcloud beta run services update CLOUD_RUN_SERVICE_NAME \
       --set-env-vars="^|^ENDPOINTS_SERVICE_NAME=YOUR_SERVICE_NAME|ESP_ARGS=--rollout_strategy=managed,--cors_preset=basic" \
       --project ESP_PROJECT_ID
    

    ENDPOINTS_SERVICE_NAME--rollout_strategy를 포함해야 합니다.

  3. ESP에 IAP 보안 앱을 호출할 수 있는 권한을 부여합니다. 다음 명령어를 실행합니다. 이때 명령어의 각 값을 다음과 같이 바꿉니다.

    • APP_PROJECT_ID를 App Engine 프로젝트 ID의 이름으로 바꿉니다.
    • ESP_PROJECT_NUMBER를 ESP에 생성한 프로젝트의 프로젝트 번호로 바꿉니다. 이 번호를 찾는 한 가지 방법은 IAM 콘솔로 이동하여 member 플래그에서 사용된 서비스 계정인 기본 컴퓨팅 서비스 계정을 확인하는 것입니다.
    gcloud projects add-iam-policy-binding APP_PROJECT_ID \
        --member "serviceAccount:ESP_PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
        --role "roles/iap.httpsResourceAccessor"
    

API에 요청 보내기

이 섹션에서는 API에 요청을 보내는 방법을 설명합니다.

  1. Endpoints 서비스 이름의 환경 변수를 만듭니다. OpenAPI 문서의 host 필드에 지정한 이름입니다. 예를 들면 다음과 같습니다.
    • Linux 또는 macOS:

      export ENDPOINTS_HOST=gateway-12345-uc.a.run.app

    • Windows PowerShell:

      $Env: ENDPOINTS_HOST="gateway-12345-uc.a.run.app"

Linux 또는 Mac OS

curl을 사용하여 이전 단계에서 설정한 ENDPOINTS_HOST 환경 변수를 통해 HTTP 요청을 전송합니다.

curl --request GET \
   --header "content-type:application/json" \
   "https://${ENDPOINTS_HOST}/hello"

PowerShell

Invoke-WebRequest을 사용하여 이전 단계에서 설정한 ENDPOINTS_HOST 환경 변수를 통해 HTTP 요청을 전송합니다.

(Invoke-WebRequest -Method GET `
    -Headers @{"content-type"="application/json"} `
    -URI "https://$Env:ENDPOINTS_HOST/hello").Content

위의 예시에서 처음 두 행은 백틱으로 끝납니다. PowerShell에 예를 붙여넣을 때 백틱 다음에 공백이 없어야 합니다. 요청 예시에 사용된 옵션에 대한 자세한 내용은 Microsoft 문서의 Invoke-WebRequest를 참조하세요.

타사 앱

Chrome 브라우저 확장 프로그램 Postman 요청과 같은 타사 애플리케이션을 사용할 수 있습니다.

  • HTTP 동사로 GET를 선택합니다.
  • 헤더에 키 content-type 및 값 application/json을 선택합니다.
  • 환경 변수 대신 실제 URL을 사용합니다. 예를 들면 다음과 같습니다.

    https://gateway-12345-uc.a.run.app/hello
    

성공적인 응답을 받지 못했으면 응답 오류 문제해결을 참조하세요.

Endpoints에 API를 배포하고 테스트했습니다.

API 활동 추적

  1. Cloud Console의 Endpoints > 서비스 페이지에서 API의 활동 그래프를 봅니다.

    Endpoints 활동 그래프 보기

    요청이 그래프에 반영되는 데 잠시 시간이 걸릴 수 있습니다.

  2. 로그 뷰어 페이지에서 API의 요청 로그를 봅니다.

    Endpoints 요청 로그 보기

API의 개발자 포털 만들기

Cloud Endpoints 포털을 사용하여 샘플 API와 상호작용하는 데 사용할 수 있는 웹사이트인 개발자 포털을 만들 수 있습니다. 자세한 내용은 Cloud Endpoints 포털 개요를 참조하세요.

삭제

이 빠른 시작에서 사용한 리소스의 비용이 Google Cloud 계정에 청구되지 않도록 하려면 다음 단계를 따르세요.

이 가이드에서 사용되는 서비스를 중지하는 방법에 대한 자세한 내용은 API 및 API 인스턴스 삭제를 참조하세요.

다음 단계