API 배포 및 테스트

이 페이지는 API를 배포하는 방법을 설명합니다.

시작하기 전에

프로덕션에 API 배포

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

  1. ENDPOINTS_GAE_SDK 환경 변수를 App Engine SDK 폴더 Path_to_Cloud_SDK/platform/google_appengine의 경로로 설정합니다.

    Path_to_Cloud_SDK를 다음 명령어의 출력으로 바꿉니다.

     gcloud info --format="value(installation.sdk_root)"

  2. API 기본 디렉토리에서 다음 명령어를 실행합니다.

     gcloud app deploy

    경고 메시지를 무시하고 배포가 완료될 때까지 잠시 기다립니다. 배포가 완료되면 다음과 유사한 메시지가 표시됩니다.

    File upload done.
Updating service [default]...done.

  3. API에 테스트 요청을 보내서 배포에 성공했는지 확인합니다. 예를 들면 다음과 같습니다.

    curl --request POST \
   --header "Content-Type: application/json" \
   --data '{"content":"echo"}' \
   https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2

    PROJECT_ID를 프로젝트 ID로 바꾸고, echo를 API 이름으로 바꿉니다.

    결과는 다음과 같습니다.

    {
 "content": "echo echo"
}

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

여러 앱 버전에 배포

API 버전 관리 방법과 버전에 배포 방법에 대한 자세한 내용은 API 버전 관리를 참조하세요.

로컬에서 API 테스트

App Engine 로컬 개발 서버를 사용하면 로컬에서 API를 테스트할 수 있습니다. 로컬 개발 서버에 대한 자세한 내용은 로컬 개발 서버 사용을 참조하세요.

로컬에서 API를 실행하려면 다음 안내를 따르세요.

  1. 프로젝트의 루트 디렉토리에서 App Engine 개발 서버를 시작합니다.

    dev_appserver.py YOUR_PROJECT_DIR

  2. curl을 실행하여 API를 요청합니다. 예를 들면 다음과 같습니다.

     curl --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"echo"}' \
    "${HOST}/_ah/api/echo/v1/echo?n=2"

API 관리 추가

Endpoints Frameworks는 다음과 같은 API 관리 기능을 제공합니다.

Endpoints Frameworks로 API를 관리하려면 API 관리 추가의 설명에 따라 API를 기술하는 OpenAPI 문서를 생성하고 배포해야 합니다.