Python용 Cloud Endpoints Frameworks 시작하기

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

목표

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

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

비용

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

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

이 문서에 설명된 태스크를 완료했으면 만든 리소스를 삭제하여 청구가 계속되는 것을 방지할 수 있습니다. 자세한 내용은 삭제를 참조하세요.

시작하기 전에

Google Cloud 계정에 로그인합니다. Google Cloud를 처음 사용하는 경우 계정을 만들고 Google 제품의 실제 성능을 평가해 보세요. 신규 고객에게는 워크로드를 실행, 테스트, 배포하는 데 사용할 수 있는 $300의 무료 크레딧이 제공됩니다.

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

프로젝트 선택기로 이동

Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

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

프로젝트 선택기로 이동

Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.

Google Cloud 프로젝트 ID는 나중에 필요하므로 적어 둡니다.

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

Python용 Google Cloud CLI 설치의 안내에 따라 App Engine 표준 개발 환경을 설정합니다. app-engine-python 및 app-engine-python-extras gcloud 구성요소를 설치하시기 바랍니다.
다음 명령어를 실행합니다.
1. gcloud CLI를 업데이트합니다.
```
gcloud components update
```
2. Google Cloud CLI(gcloud)에 Google Cloud의 데이터 및 서비스에 액세스할 수 있는 권한이 있는지 확인합니다.
```
gcloud auth login
```
3. 새 브라우저 탭이 열리면 계정을 선택합니다.
4. 기본 프로젝트를 프로젝트 ID로 설정합니다.
```
gcloud config set project [YOUR_PROJECT_ID]
```
  [YOUR_PROJECT_ID]를 Google Cloud 프로젝트 ID로 바꿉니다. 다른 Google Cloud 프로젝트가 있고 gcloud를 사용하여 이러한 프로젝트를 관리하려면 gcloud CLI 구성 관리를 참조하세요.
애플리케이션이 요청을 샘플 API로 전송하도록 해야 합니다.
- Linux 및 macOS 사용자: 이 가이드에서 제공하는 예시에서는 일반적으로 운영체제에 사전 설치되어 제공되는 curl을 사용합니다. curl이 없으면 curl 릴리스 및 다운로드 페이지에서 다운로드할 수 있습니다.
- Windows 사용자: 이 가이드에서 제공하는 예시에서는 PowerShell 3.0 이상에서 지원되는 Invoke-WebRequest를 사용합니다.
Python 개발 환경에 pip가 포함되어 있는지 확인합니다.
Python용 C 확장 프로그램을 컴파일할 수 있는지 확인합니다.
- Windows: Microsoft Visual C++ 9.0 이상이 필요합니다. Python 2.7용 Microsoft Visual C++ 컴파일러는 Microsoft 다운로드 센터에서 다운로드할 수 있습니다.
- 기타 운영체제: 운영체제에 따라 컴파일러 도구(build-essential라는 패키지에 포함될 때도 있음) 또는 Python 개발 헤더 (python-dev라는 패키지에 포함)를 설치해야 할 수 있습니다.
Linux의 경우 ENDPOINTS_GAE_SDK 환경 변수를 App Engine SDK 폴더의 경로로 설정합니다. 예시: [Path-to-Google-Cloud-SDK]/platform/google_appengine

[Path-to-Google-Cloud-SDK]를 다음 명령어의 출력으로 바꿉니다.
```
gcloud info --format="value(installation.sdk_root)"
```
App Engine 애플리케이션을 만듭니다.
1. App Engine 애플리케이션을 만들 리전을 선택합니다. 다음 명령어를 실행하여 리전 목록을 가져옵니다.
```
gcloud app regions list
```
2. 다음 명령어를 사용하여 App Engine 애플리케이션을 만듭니다. [YOUR_PROJECT_ID]는 Google Cloud 프로젝트 ID로 바꾸고, [YOUR_REGION]은 생성되는 App Engine 애플리케이션이 위치할 리전으로 바꿉니다.
```
gcloud app create \
--project=[YOUR_PROJECT_ID] \
--region=[YOUR_REGION]
```
  예를 들면 다음과 같습니다.
```
gcloud app create --project=example-project-12345 --region=us-central
```

샘플 코드 가져오기

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

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

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

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

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 라이브러리를 샘플에 추가하려면 다음 안내를 따르세요.

현재 위치가 샘플 API의 기본 디렉터리 python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo인지 확인합니다.
프로젝트에 /lib 하위 디렉터리를 만듭니다.
```
mkdir lib
```
샘플 기본 디렉터리 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 문서를 생성하려면 다음 안내를 따르세요.

현재 위치가 다음의 샘플 주 디렉토리인지 확인합니다.
```
python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
```
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와 서비스를 만들고 관리하는 데 사용되는 서비스 인프라를 사용합니다.

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

현재 위치가 다음의 샘플 주 디렉토리인지 확인합니다.
```
python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
```
다음 명령어를 실행하여 이전 섹션에서 생성한 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를 참조하세요.

필수 서비스 확인

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 구성을 배포한 후에는 로컬 개발 서버를 사용하여 샘플을 로컬에서 실행할 수 있습니다.

현재 위치가 다음의 샘플 주 디렉토리인지 확인합니다.
```
python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo
```
로컬 개발 서버를 시작합니다.
```
dev_appserver.py ./app.yaml
```
기본적으로 개발 서버는 dev_appserver.py에서 출력하는 Google Cloud Console 로그에 표시된 대로 http://localhost:8080에서 수신을 대기합니다.
```
INFO 2018-01-01 [...] Starting module "default" running at: http://localhost:8080
```
로컬 개발 서버에 요청을 보냅니다.

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 백엔드를 배포하려면 다음 안내를 따르세요.

다음 명령어를 실행하여 서비스 구성 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
```

python-docs-samples/appengine/standard/endpoints-frameworks-v2/echo 디렉터리에서 app.yaml 파일을 엽니다.

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

env_variables 섹션에서 다음과 같이 변경합니다.
- ENDPOINTS_SERVICE_NAME 필드에서 YOUR-PROJECT-ID를 Google Cloud 프로젝트 ID로 바꿉니다.
- ENDPOINTS_SERVICE_VERSION 필드에서 텍스트를 서비스 구성 ID로 바꿉니다. 예를 들면 다음과 같습니다.
```
  ENDPOINTS_SERVICE_NAME: example-project-12345.appspot.com
  ENDPOINTS_SERVICE_VERSION: 2017-02-13r2
```
다음 명령어를 실행합니다.
```
gcloud app deploy
```
화면에 표시되는 안내를 따릅니다. 경고 메시지를 무시하고 배포가 완료될 때까지 잠시 기다립니다. 배포가 완료되면 다음과 유사한 메시지가 표시됩니다.
```
File upload done.
Updating service [default]...done.
```
오류 메시지가 표시되면 App Engine 문서의 문제해결 섹션에서 정보를 참조하세요.

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

샘플 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"
}

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

API 활동 추적

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

Endpoints 서비스 페이지로 이동

요청이 그래프에 반영되는 데 잠시 시간이 걸릴 수 있습니다.
로그 탐색기 페이지에서 API의 요청 로그를 봅니다.

로그 탐색기 페이지로 이동

API의 개발자 포털 만들기

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

삭제

이 튜토리얼에서 사용된 리소스 비용이 Google Cloud 계정에 청구되지 않도록 하려면 리소스가 포함된 프로젝트를 삭제하거나 프로젝트를 유지하고 개별 리소스를 삭제하세요.

Google Cloud 콘솔에서 리소스 관리 페이지로 이동합니다.
리소스 관리로 이동
프로젝트 목록에서 삭제할 프로젝트를 선택하고 삭제를 클릭합니다.
대화상자에서 프로젝트 ID를 입력한 후 종료를 클릭하여 프로젝트를 삭제합니다.

다음 단계

Endpoints Frameworks 아키텍처에 대해 알아보기
API 만들기에 대해 알아보기
API를 제공하는 웹 서버 만들기에 대해 알아보기
다른 경로에서 API 제공에 대해 알아보기
API 모니터링에 대해 알아보기
API 키로 액세스 제한에 대해 알아보기
커스텀 도메인 이름 구성에 대해 알아보기
API 버전 관리 처리에 대해 알아보기
지원 옵션에 대해 알아보기