API 배포 및 테스트

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

시작하기 전에

API 배포

App Engine Apache Maven 또는 Gradle 플러그인을 사용하여 API를 배포할 수 있습니다. 프로덕션 App Engine 표준 환경에 API를 배포하려면 플러그인에 맞는 명령어를 사용합니다.

  1. 플러그인에 다음 명령어를 사용합니다.

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. 배포가 완료될 때까지 기다립니다.

  3. 배포된 API에 테스트 요청을 보냅니다. 예를 들어 다음과 같이 curl을 사용합니다.

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"

    응답은 다음과 비슷합니다.

    {
  "message": "echo echo"
}

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

여러 애플리케이션 버전에 배포

API 버전을 관리하고 여러 버전에 배포하는 방법에 대한 자세한 내용은 API 버전 관리를 참조하세요.

로컬로 API 백엔드 실행 및 테스트

로컬로 API를 테스트하려면 다음 단계를 따르세요.

  1. 프로젝트의 루트 디렉토리에 프로젝트를 빌드합니다. 예를 들면 다음과 같습니다.

    Maven

    mvn clean package

    Gradle

    gradle clean build

  2. App Engine 개발 서버를 시작합니다. 예를 들면 다음과 같습니다.

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun

  3. API를 테스트하기 위해 API 요청을 보냅니다. 예를 들어, curl을 사용하는 경우에는 다음 명령어를 실행합니다.

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

다른 경로에서 API 제공

다른 경로에서 API를 제공하려면 web.xml 파일에서 EndpointsServlet 섹션의 url-pattern을 변경하고 API를 재배포합니다. 예를 들면 다음과 같습니다.

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

API 관리 추가

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

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