자바용 Cloud Endpoints Frameworks 시작하기

이 페이지에서는 자바용 Cloud Endpoints Frameworks를 사용하여 샘플 API를 구성, 배포하고 이러한 API로 요청을 보내는 방법을 보여줍니다. 자바용 Endpoints Frameworks는 App Engine 표준 자바 8 런타임 환경과 통합되어 있습니다. Endpoints Frameworks는 App Engine 애플리케이션에서 API 및 클라이언트 라이브러리를 생성할 수 있는 도구, 라이브러리, 기능으로 구성됩니다.

목표

아래의 개략적인 작업 목록을 사용하여 가이드를 진행합니다. API에 성공적으로 요청을 보내려면 모든 태스크를 수행해야 합니다.

  1. Google Cloud 프로젝트를 설정합니다. 시작하기 전에를 참조하세요.
  2. 필수 소프트웨어를 설치하고 App Engine 애플리케이션을 만듭니다. 필수 소프트웨어 설치 및 구성을 참조하세요.
  3. 샘플 코드를 다운로드합니다. 샘플 코드 받기를 참조하세요.
  4. OpenAPI 구성 파일을 생성합니다. Cloud Endpoints 구성을 참조하세요.
  5. Endpoints 구성을 배포하여 Endpoints 서비스를 만듭니다. Endpoints 구성 배포를 참조하세요.
  6. 컴퓨터에서 샘플을 실행합니다. 로컬에서 샘플 실행을 참조하세요.
  7. API를 제공할 백엔드를 만들고 API를 배포합니다. API 백엔드 배포를 참조하세요.
  8. API에 요청을 보냅니다. API에 요청 보내기를 참조하세요.
  9. API 활동을 추적합니다. API 활동 추적을 참조하세요.
  10. Google Cloud 계정에 요금이 청구되지 않도록 합니다. 삭제를 참조하세요.

비용

이 가이드에서는 비용이 청구될 수 있는 다음과 같은 Google Cloud 구성요소를 사용합니다.

프로젝트 사용량을 기준으로 예상 비용을 산출하려면 가격 계산기를 사용하세요. Google Cloud를 처음 사용하는 사용자는 무료 체험판을 사용할 수 있습니다.

이 가이드를 마치면 만든 리소스를 삭제하여 비용이 계속 청구되지 않게 할 수 있습니다. 자세한 내용은 삭제를 참조하세요.

시작하기 전에

  1. Google 계정으로 로그인합니다.

    아직 계정이 없으면 새 계정을 등록하세요.

  2. Google Cloud Console의 프로젝트 선택기 페이지에서 Google Cloud 프로젝트를 선택하거나 만듭니다.

    프로젝트 선택기 페이지로 이동

  3. Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다. 프로젝트에 결제가 사용 설정되어 있는지 확인하는 방법을 알아보세요.

  4. 나중에 필요하므로 프로젝트 ID를 기록합니다.

필수 소프트웨어 설치 및 구성

  1. 자바 8이 설치되어 있지 않으면 Oracle에서 JDK(Java Development Kit)를 다운로드하여 설치합니다. 자바용 Endpoints Framework는 App Engine 표준 자바 8 런타임 환경을 사용하므로, Endpoints Framework는 다른 버전의 자바를 지원하지 않습니다.
  2. Maven 3.3.9 이상이 없으면 이를 다운로드하여 설치합니다.
  3. Windows 사용자 참고사항: Windows에 JDK와 Maven을 설치하는 경우, 경로에 공백이 없는 디렉터리에 설치하세요. 자세한 내용은 Windows에서 Maven 실행을 참조하세요.

  4. 애플리케이션이 요청을 샘플 API로 전송하도록 해야 합니다.

    • Linux 및 macOS 사용자: 이 가이드에서 제공하는 예시에서는 일반적으로 운영체제에 사전 설치되어 제공되는 curl을 사용합니다. curl이 없으면 curl 릴리스 및 다운로드 페이지에서 다운로드할 수 있습니다.
    • Windows 사용자: 이 가이드에서 제공하는 예시에서는 PowerShell 3.0 이상에서 지원되는 Invoke-WebRequest를 사용합니다.
  5. Cloud SDK를 다운로드하고 초기화합니다.
  6. 다음 명령어를 실행합니다.
    1. Cloud SDK에 Google Cloud의 데이터 및 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.
      gcloud auth login
    2. 애플리케이션 기본 사용자 인증 정보를 사용합니다.
      gcloud auth application-default login
    3. Cloud SDK app-engine-java 구성요소를 설치합니다.
      gcloud components install app-engine-java
    4. Cloud SDK와 모든 구성요소를 최신 버전으로 업데이트합니다.
      gcloud components update
  7. App Engine 애플리케이션을 만듭니다.
    1. 기본 프로젝트를 프로젝트 ID로 설정합니다.
      gcloud config set project YOUR_PROJECT_ID

      YOUR_PROJECT_ID를 Google Cloud 프로젝트 ID로 바꿉니다. 다른 Google Cloud 프로젝트가 있고, gcloud를 사용하여 이를 관리하려면 Cloud SDK 구성 관리를 참조하세요.

    2. App Engine 애플리케이션을 만들 리전을 선택합니다. 다음 명령어를 실행하여 리전 목록을 가져옵니다.
      gcloud app regions list
    3. 다음 명령어를 사용하여 App Engine 애플리케이션을 만듭니다. YOUR_PROJECT_ID를 Google Cloud 프로젝트 ID로 바꾸고 YOUR_REGION을 App Engine 애플리케이션을 생성하려는 리전으로 바꿉니다.
      gcloud app create \
      --project=YOUR_PROJECT_ID \
      --region=YOUR_REGION
      

샘플 코드 가져오기

GitHub에서 샘플 API를 복제하려면 다음 안내를 따르세요.

  1. 샘플 저장소를 로컬 머신에 복제합니다.

    git clone https://github.com/GoogleCloudPlatform/java-docs-samples
    
  2. 샘플 코드가 포함된 디렉토리로 변경합니다.

    cd java-docs-samples/appengine-java8/endpoints-v2-backend
    

Endpoints 구성

샘플 코드에는 샘플 코드의 REST API를 설명하는 OpenAPI 구성 파일을 생성하는 Endpoints Frameworks 도구가 포함되어 있습니다. 이 섹션의 단계를 따라 샘플 Maven 프로젝트를 구성 및 빌드하면 OpenAPI 구성 파일을 생성할 수 있습니다.

샘플 API 코드에 프로젝트 ID 추가

코드를 배포하려면 먼저 프로젝트 생성 시 가져온 프로젝트 ID를 샘플의 pom.xml에 추가해야 합니다.

프로젝트 ID를 추가하려면 다음 안내를 따르세요.

  1. java-docs-samples/appengine-java8/endpoints-v2-backend/pom.xml 파일을 수정합니다.

  2. <endpoints.project.id>를 찾고 YOUR_PROJECT_ID를 Google Cloud 프로젝트 ID로 바꿉니다.

    예를 들면 다음과 같습니다.

    <endpoints.project.id>example-project</endpoints.project.id>
    
  3. 변경사항을 저장합니다.

샘플 프로젝트 빌드

프로젝트를 빌드하려면 다음 안내를 따르세요.

  1. java-docs-samples/appengine-java8/endpoints-v2-backend 디렉터리에 있는지 확인합니다.

  2. 다음 명령어를 실행합니다.

    mvn clean package
    
  3. 프로젝트가 빌드될 때까지 기다립니다. 프로젝트가 성공적으로 완료되면 다음과 비슷한 메시지가 표시됩니다.

    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 14.846s
    [INFO] Finished at: Wed April 13 09:43:09 PDT 2016
    [INFO] Final Memory: 24M/331M
    

OpenAPI 구성 파일 생성

Endpoints Frameworks 라이브러리의 도구를 사용하여 openapi.json이라는 OpenAPI 문서를 생성합니다. 이 파일은 샘플 코드의 REST API를 설명합니다.

OpenAPI 구성 파일을 생성하려면 다음 안내를 따르세요.

  1. 다음 명령어를 사용하여 Endpoints Frameworks 도구를 호출합니다.

    mvn endpoints-framework:openApiDocs
    
  2. 구성 사양이 빌드될 때까지 기다립니다. 완료되면 다음과 비슷한 메시지가 표시됩니다.

    OpenAPI document written to target/openapi-docs/openapi.json
    

    정적 로거 클래스 로드 실패와 관련된 메시지를 무시합니다.

Endpoints 구성 배포

Endpoints 구성을 배포하려면 Endpoints Frameworks와 기타 서비스에서 API와 서비스를 만들고 관리하는 데 사용되는 Google의 기초 서비스 플랫폼인 서비스 인프라를 사용합니다.

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

  1. java-docs-samples/appengine-java8/endpoints-v2-backend 디렉터리에 있는지 확인합니다.

  2. 이전 섹션에서 생성된 OpenAPI 구성 파일을 배포합니다.

    gcloud endpoints services deploy target/openapi-docs/openapi.json
    

그러면 YOUR_PROJECT_ID.appspot.com 형식의 이름을 가진 새로운 Endpoints 서비스가 생성됩니다. 이 이름은 pom.xml 및 샘플의 기타 구성 파일에서 구성됩니다. App Engine에서 API를 배포하는 경우, API에 요청 전송 시 사용하는 정규화된 도메인 이름(FQDN)인 YOUR_PROJECT_ID.appspot.com 이름 형식을 사용하여 DNS 레코드가 생성됩니다.

서비스 생성 및 구성 시 Service Management는 터미널에 정보를 출력합니다. openapi.json 경로에 API 키가 필요하지 않다는 경고는 무시해도 됩니다. 성공적으로 완료되면 서비스 구성 ID와 서비스 이름을 보여주는 다음과 같은 줄이 표시됩니다.

Service Configuration [2017-02-13-r2] uploaded for service [example-project-12345.appspot.com]

앞의 예시에서 2017-02-13-r2는 서비스 구성 ID이고 example-project-12345.appspot.com은 서비스 이름입니다.

자세한 내용은 gcloudEndpoints 서비스 배포를 참조하세요.

필수 서비스 확인

Endpoints Frameworks가 API 관리를 제공하려면 다음과 같은 서비스가 필요합니다.
이름 제목
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 서비스를 참조하세요.

로컬에서 샘플 실행

Endpoints 구성을 배포한 후에는 샘플을 로컬에서 실행할 수 있습니다.

  1. 샘플의 appengine-web.xml 파일에서 호스트 이름을 설정하는 데 사용되는 ENDPOINTS_SERVICE_NAME이라는 환경 변수를 만듭니다. 다음에서 YOUR_PROJECT_ID를 Google Cloud 프로젝트 ID로 바꿉니다.

    Linux 또는 Mac OS:

    export ENDPOINTS_SERVICE_NAME=YOUR_PROJECT_ID.appspot.com
    

    Windows PowerShell:

    $Env:ENDPOINTS_SERVICE_NAME="YOUR_PROJECT_ID.appspot.com"
    
  2. 애플리케이션 기본 사용자 인증 정보에 사용할 새로운 사용자 인증 정보를 가져옵니다.

    gcloud auth application-default login
    
  3. 개발 서버를 실행합니다.

    mvn appengine:run
    

    로컬 인스턴스는 mvn appengine:run 명령어로 인쇄된 로그에 표시된 것처럼 http://localhost:8080으로 연결할 수 있습니다.

    [INFO] GCLOUD: INFO: Module instance default is running at http://localhost:8080/
    
  4. 로컬 인스턴스에 요청을 전송합니다.

Linux 또는 Mac OS

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"hello world"}' \
    http://localhost:8080/_ah/api/echo/v1/echo

앞의 curl에서,

  • --data 옵션은 API에 게시할 데이터를 지정합니다.
  • --header 옵션은 데이터가 JSON 형식임을 지정합니다.

PowerShell

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://localhost:8080/_ah/api/echo/v1/echo").Content

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

API가 받은 메시지를 되풀이하고 다음과 같이 응답합니다.

{
 "message": "hello world"
}

API 백엔드 배포

지금까지 OpenAPI 구성을 Service Management에 배포했지만 아직 API 백엔드를 제공할 코드를 배포하지 않았습니다. 이 섹션에서는 샘플 API를 App Engine에 배포하는 과정을 안내합니다.

API 백엔드를 배포하려면 다음 안내를 따르세요.

  1. java-docs-samples/appengine-java8/endpoints-v2-backend 디렉터리에 있는지 확인합니다.

  2. Maven을 사용해서 API 구현 코드를 배포합니다.

     mvn appengine:deploy
    

    샘플 앱을 처음 업로드하면 배포 권한을 부여하라는 메시지가 표시될 수 있습니다. 안내를 따릅니다. 코드가 포함된 브라우저 창이 표시되면 이를 터미널 창에 복사합니다.

  3. 업로드가 완료될 때까지 기다립니다.

    API에 요청을 보내기 전에 App Engine이 완전히 초기화되는 동안 몇 분 기다리는 것이 좋습니다.

API에 요청 보내기

API와 해당 구성 파일을 배포한 후에 API에 요청을 보낼 수 있습니다.

Linux 또는 Mac OS

curl을 사용하여 HTTP 요청을 전송합니다. [YOUR_PROJECT_ID]를 Google Cloud 프로젝트 ID로 바꿉니다.

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"hello world"}' \
    https://[YOUR_PROJECT_ID].appspot.com/_ah/api/echo/v1/echo

앞의 curl에서,

  • --data 옵션은 API에 게시할 데이터를 지정합니다.
  • --header 옵션은 데이터가 JSON 형식임을 지정합니다.

PowerShell

Invoke-WebRequest을 사용하여 HTTP 요청을 전송합니다. [YOUR_PROJECT_ID]를 Google Cloud 프로젝트 ID로 바꿉니다.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} -URI `
     "https://[YOUR_PROJECT_ID].appspot.com/_ah/api/echo/v1/echo").Content

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

타사 앱

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

  • HTTP 동사로 POST를 선택합니다.
  • 헤더에 키 content-type 및 값 application/json을 선택합니다.
  • 본문에 다음을 입력합니다.
    {"message":"hello world"}
  • 샘플 애플리케이션의 URL을 입력합니다. 예를 들면 다음과 같습니다.
    https://example-project-12345.appspot.com/_ah/api/echo/v1/echo

API가 받은 메시지를 되풀이하고 다음과 같이 응답합니다.

{
 "message": "hello world"
}

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

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

API 활동 추적

  1. Endpoints > 서비스 페이지에서 Cloud Console에 있는 API의 활동 그래프를 확인합니다.

    Endpoints 서비스 페이지로 이동

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

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

    로그 뷰어 페이지로 이동

API의 개발자 포털 만들기

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

삭제

이 가이드에서 사용한 리소스 비용이 Google Cloud Platform 계정에 청구되지 않도록 하려면 다음의 방법을 따르세요.

  1. Cloud Console에서 리소스 관리 페이지로 이동합니다.

    리소스 관리로 이동

  2. 프로젝트 목록에서 삭제할 프로젝트를 선택하고 삭제를 클릭합니다.
  3. 대화상자에서 프로젝트 ID를 입력한 후 종료를 클릭하여 프로젝트를 삭제합니다.

다음 단계