App Engine용 Cloud Endpoints 프레임워크 명령줄 도구

이 페이지에서는 Endpoints 프레임워크 명령줄 도구를 사용하여 백엔드 서버 API에서 클라이언트 라이브러리를 생성하는 방법을 설명합니다. 모든 자바 또는 Android 앱에서 이 라이브러리를 사용하여 API를 호출할 수 있습니다.

Endpoints 프레임워크 명령줄 도구를 사용하여 애플리케이션에서 API에 액세스할 수 있게 해주는 클라이언트 라이브러리 번들을 생성할 수 있습니다. 클라이언트 라이브러리를 생성하면 Endpoints 프레임워크 명령줄 도구는 API 노출 영역을 기술하는 검색 문서를 자동으로 생성합니다.

Endpoints 프레임워크 명령줄 도구가 필요하면 Maven Central Repository에서 endpoints-framework-tools를 다운로드하세요. zip 파일의 콘텐츠를 추출한 후 endpoints-framework-tools-2.2.1/bin/ 디렉터리에서 이 도구를 찾을 수 있습니다.

API에서 클라이언트 라이브러리 번들 생성

Endpoints 프레임워크 명령줄 도구를 사용하면 다음 유형의 클라이언트 번들을 생성할 수 있습니다.

  • Maven: 이 번들에는 Endpoints 프레임워크 및 Google API 클라이언트 라이브러리 종속 항목을 포함하는 pom.xml 파일이 포함됩니다. readme.html 파일은 다양한 클라이언트 애플리케이션 유형별로 pom.xml 파일에 추가해야 하는 항목과 Maven을 사용하여 API에 맞는 클라이언트 라이브러리를 빌드하는 방법에 대한 자세한 정보를 제공합니다.

  • Gradle: 이 번들에는 Endpoints 프레임워크 및 Google API 클라이언트 라이브러리 종속 항목을 포함하는 build.gradle 파일이 포함됩니다. readme.html 파일은 다양한 클라이언트 애플리케이션 유형별로 build.gradle 파일에 추가해야 하는 항목과 Gradle을 사용하여 API에 맞는 클라이언트 라이브러리를 빌드하는 방법에 대한 자세한 정보를 제공합니다.

  • 기본 클라이언트 번들: 이 번들에는 모든 종속 항목 라이브러리와 생성된 source.jar 파일이 포함됩니다. 이 파일은 클라이언트에서 API를 호출하는 데 사용하는 자바 라이브러리입니다. 이 번들은 OAuth를 포함한 모든 Google API 클라이언트 라이브러리 기능을 클라이언트에 제공합니다. readme.html 파일은 다양한 유형의 클라이언트 애플리케이션에 필요한 .jar 파일의 목록과 클라이언트 라이브러리 사용을 위한 그 밖의 자세한 정보를 제공합니다.

Android 앱에서 클라이언트 라이브러리를 사용하는 경우 Gradle 클라이언트 번들을 사용하는 것이 좋습니다.

명령줄 구문

Endpoints 프레임워크 명령줄 도구에는 컴파일된 바이너리가 필요하므로 이 도구를 사용하려면 먼저 백엔드 프로젝트를 빌드해야 합니다. 기본값(--war="./war")을 사용하지 않으려면 WEB-INF 디렉터리와 컴파일된 자바 클래스가 포함된 대상 출력 디렉터리를 가리키는 --war= 옵션을 제공해도 됩니다.

기본 구문은 다음과 같습니다.

/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
    get-client-lib OPTIONS CLASS_NAME

각 매개변수는 다음과 같습니다.

  • OPTIONS옵션 표에 표시된 하나 이상의 항목입니다(제공된 경우).
  • CLASS_NAME은 API의 정규화된 클래스 이름입니다.

예:

/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
    get-client-lib --war=target/echo-1.0-SNAPSHOT -bs gradle com.example.echo.Echo

여기서 target/echo-1.0-SNAPSHOTWEB-INF와 컴파일된 백엔드 클래스를 포함하는 대상 빌드 디렉터리의 상대 경로 또는 절대 경로입니다.

옵션

다음 옵션을 사용할 수 있습니다.

옵션 이름 설명
build-system 생성할 클라이언트 번들의 유형을 지정할 수 있습니다. Android용 Gradle 클라이언트 번들에는 gradle을 지정하고, Maven 클라이언트 번들에는 maven을 지정하고, 종속 항목 라이브러리와 소스 jar만 포함하는 번들에는 default를 지정하거나 이 옵션을 생략합니다. --build-system=gradle
-bs gradle
war appengine-web.xml과 기타 메타데이터를 포함하는 빌드 대상 디렉터리 WEB-INF의 경로를 설정합니다.
기본값: ./war
--war=target/echo-1.0-SNAPSHOT
-w target/echo-1.0-SNAPSHOT
output 출력이 기록되는 디렉터리를 설정합니다.
기본값: 도구가 호출되는 디렉터리
--output=/mydir
-o /mydir

지원되는 클라이언트 플랫폼

Endpoints 프레임워크 명령줄 도구로 생성된 클라이언트 번들에서 지원되는 플랫폼은 다음과 같습니다.