Python용 Cloud Endpoints Frameworks 시작하기

샘플 코드 가져오기

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

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

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

2. 샘플 코드가 포함된 디렉토리로 변경합니다.

   cd python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
   

Endpoints 구성

Endpoints를 구성하려면 먼저 Endpoints Frameworks 라이브러리를 설치해야 합니다. 그런 다음 Endpoints Frameworks 라이브러리의 도구를 사용하여 샘플 API용 OpenAPI 문서를 생성합니다. Endpoints가 API를 관리하기 위해서는 Endpoints Frameworks 라이브러리와 OpenAPI 문서가 필요합니다. 자세한 내용은 API 관리 추가를 참조하세요.

Endpoints Frameworks 라이브러리 설치

이 섹션에서는 Python의 pip를 사용하여 Endpoints Frameworks 라이브러리를 샘플 API의 프로젝트 디렉터리에 추가하는 과정을 안내합니다.

Endpoints Frameworks 라이브러리를 샘플에 추가하려면 다음 안내를 따르세요.

1. 현재 위치가 샘플 API의 기본 디렉터리 python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo인지 확인합니다.

2. 프로젝트에 /lib 하위 디렉터리를 만듭니다.

   mkdir lib
   

3. 샘플 기본 디렉터리 python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo에서 설치 명령어를 실행합니다.

   pip install --target lib --requirement requirements.txt --ignore-installed
   

   다음에 유의하세요.

   • 이 pip 명령어는 GNU Compiler Collection(GCC)을 사용하여 확장 모듈을 컴파일할 수 있습니다. macOS를 사용 중이고 시스템에서 GCC를 처음 실행한 경우라면 Apple의 XCode 라이선스를 허용해야 할 수도 있습니다. 이 작업을 수행하려면 sudo xcodebuild -license 명령어를 실행합니다.

   • 컴퓨터에 여러 Python 버전이 설치되어 있는 경우에는 이 가이드에서 사용하는 Python 버전에 해당하는 pip 버전을 사용하고 있는지 확인하세요. 버전이 일치하지 않으면(예: Python 2.7은 python, Python 3.4는 pip 사용) 이해하기 어려운 오류가 발생할 수 있습니다. 필요하다면 pip를 Python 모듈로 실행할 수 있습니다. 이전의 명령어에서 pip를 python -m pip로 바꾸세요.

   • 명령어를 실행할 때 pip가 적합한 패키지를 찾지 못하면 pip install --upgrade pip를 실행하여 업그레이드하세요. 업그레이드가 완료되면 설치 명령어를 다시 실행해 봅니다.

   • 일부 Debian 및 Ubuntu 버전에서 pip에 DistutilsOptionError가 발생할 수 있습니다. 이 오류가 표시되면 --system 플래그를 추가하세요.

성공적으로 완료되면 Endpoints Frameworks 애플리케이션을 빌드하는 데 필요한 파일이 lib 디렉터리에 채워집니다.

OpenAPI 문서 생성

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

OpenAPI 문서를 생성하려면 다음 안내를 따르세요.

1. 현재 위치가 다음의 샘플 주 디렉토리인지 확인합니다.

   python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
   

2. OpenAPI 문서를 생성합니다.

   python lib/endpoints/endpointscfg.py get_openapi_spec main.EchoApi --hostname [YOUR_PROJECT_ID].appspot.com
   

   [YOUR_PROJECT_ID]를 Google Cloud 프로젝트 ID로 바꿉니다. 경고가 표시되면 무시하세요. Endpoints 도구는 현재 디렉터리에 echov1openapi.json이라는 OpenAPI 문서를 생성합니다. Endpoints 도구는 @endpoints.api 데코레이터에 지정된 서비스의 이름과 버전에 따라 파일명을 지정합니다. 자세한 내용은 API 만들기를 참조하세요.

   Endpoints는 hostname 인수에 지정된 텍스트를 서비스 이름으로 사용합니다. YOUR_PROJECT_ID.appspot.com 이름 형식은 API를 App Engine 백엔드에 배포할 때 자동으로 생성되는 DNS 항목과 일치합니다. 따라서 이 경우 Endpoints 서비스 이름과 FQDN(정규화된 도메인 이름)이 동일합니다.

성공적으로 완료되면 다음 메시지가 표시됩니다. OpenAPI spec written to ./echov1openapi.json

Endpoints 구성 배포

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

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

1. 현재 위치가 다음의 샘플 주 디렉토리인지 확인합니다.

   python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
   

2. 다음 명령어를 실행하여 이전 섹션에서 생성한 OpenAPI 문서를 배포합니다.

   gcloud endpoints services deploy echov1openapi.json

   이렇게 하면, Endpoints 도구를 실행하여 OpenAPI 문서를 생성할 때 hostname 인수에 지정한 이름으로 새로운 Endpoints 서비스가 생성됩니다. App Engine에 API 배포 당시 Endpoints 서비스 이름에 상관없이, DNS 레코드는 이름 형식 YOUR_PROJECT_ID.appspot.com을 사용하여 생성되는데, 이 이름 형식은 API에 요청을 보낼 때 사용하는 FQDN입니다.

   서비스를 만들고 구성할 때 서비스 관리는 많은 정보를 터미널에 출력합니다. echov1openapi.json 경로에 API 키가 필요하지 않다는 경고는 무시해도 됩니다. 배포가 완료되면 다음과 유사한 메시지가 표시됩니다.

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

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

   자세한 내용은 gcloud 참조 문서의 gcloud endpoints services deploy를 참조하세요.

필수 서비스 확인

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

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

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

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

gcloud services list

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

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

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

gcloud services enable ENDPOINTS_SERVICE_NAME

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

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

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

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

로컬에서 샘플 실행

Endpoints 구성을 배포한 후에는 로컬 개발 서버를 사용하여 샘플을 로컬에서 실행할 수 있습니다.

1. 현재 위치가 다음의 샘플 주 디렉토리인지 확인합니다.

   python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
   

2. 로컬 개발 서버를 시작합니다.

   dev_appserver.py ./app.yaml
   

   기본적으로 개발 서버는 dev_appserver.py에서 출력하는 Google Cloud 콘솔 로그에 표시된 대로 http://localhost:8080에서 수신을 대기합니다.

   INFO 2018-01-01 [...] Starting module "default" running at: http://localhost:8080
   

3. 로컬 개발 서버에 요청을 보냅니다.

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

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

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

{
 "message": "hello world"
}

API 백엔드 배포

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

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

1. 다음 명령어를 실행하여 서비스 구성 ID를 표시합니다.

   gcloud endpoints configs list --service=[YOUR_PROJECT_ID].appspot.com

   [YOUR_PROJECT_ID]를 프로젝트 ID로 바꿉니다. 예를 들면 다음과 같습니다.

   gcloud endpoints configs list --service=example-project-12345.appspot.com
   
   

2. Open the app.yaml file in the python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo directory.

   env_variables:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy swagger.json' command.
     ENDPOINTS_SERVICE_NAME: YOUR-PROJECT-ID.appspot.com
     ENDPOINTS_SERVICE_VERSION: 2016-08-01r0