개발자는 Endpoints Frameworks 명령줄 도구를 사용하여 애플리케이션이 API에 액세스할 수 있게 해주는 클라이언트 라이브러리 번들을 생성할 수 있습니다. 클라이언트 라이브러리를 생성하면 Endpoints 프레임워크 명령줄 도구는 API 노출 영역을 기술하는 검색 문서를 자동으로 생성합니다.
Endpoints 프레임워크 명령줄 도구인 endpointscfg.py는 Endpoints 프레임워크 라이브러리에서 사용할 수 있습니다. pip를 사용하여 Endpoints 프레임워크 라이브러리를 설치하는 방법에 대한 자세한 내용은 Endpoints 프레임워크 라이브러리 설치를 참조하세요.
다음 명령어를 사용하려면 lib 디렉터리에 Endpoints 프레임워크 라이브러리가 설치되어 있어야 합니다. 또한 안내에서는 백엔드 API를 이미 만들었다고 가정합니다. 샘플 코드에서 Endpoints 프레임워크 명령줄 도구를 사용하는 예시는 Python용 Endpoints Framework 가이드를 참조하세요.
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 클라이언트 번들을 사용하는 것이 좋습니다.
클라이언트 라이브러리 생성
클라이언트 라이브러리를 생성하려면 다음 안내를 따르세요.
API의
app.yaml파일과 API 서비스 클래스가 있는 디렉터리로 변경합니다. 또는--application옵션을 사용하여 애플리케이션 디렉터리의 다른 위치를 지정합니다.다음과 유사한 Endpoints 프레임워크 명령줄 도구를 호출합니다.
lib/endpoints/endpointscfg.py get_client_lib java -bs gradle main.EchoApi여기서
main은 API가 들어 있는 클래스이고EchoApi는 API 이름입니다.클라이언트 라이브러리가 생성될 때까지 기다립니다. 작업이 성공하면 다음과 비슷한 메시지가 표시됩니다.
API client library written to ./echo-v1.zipAndroid 앱에 클라이언트 라이브러리 JAR을 추가합니다.
API 코드를 수정할 때마다 위의 단계를 반복합니다.
output 옵션을 사용하여 다른 출력 디렉터리를 지정하지 않는 한 클라이언트 라이브러리 번들은 현재 디렉터리에 기록됩니다.
명령줄 구문
기본 구문은 다음과 같습니다.
/path-to/your-app/lib/endpointscfg.py get_client_lib TARGET_LANG OPTIONS CLASS_NAME
각 항목의 의미는 다음과 같습니다.
TARGET_LANG은 만들려는 클라이언트 번들 유형을 지정합니다. 현재는java값을 제공해야 합니다(Android와 같은 자바 클라이언트의 경우).OPTIONS는 옵션 표에 표시된 하나 이상의 항목입니다(제공된 경우).CLASS_NAME은 API의 정규화된 클래스 이름입니다.
옵션
다음 옵션을 사용할 수 있습니다.
| 옵션 이름 | 설명 | 예 |
|---|---|---|
application |
기본적으로 이 도구는 현재 디렉터리의 백엔드 API에서 생성됩니다. 다른 디렉터리를 사용하여 생성하려면 app.yaml을 포함하는 디렉터리의 경로와 API를 구현하는 서비스 클래스를 지정합니다. |
--application /my_path/my_api_dir |
build-system |
생성할 클라이언트 번들의 유형을 지정할 수 있습니다. Android용 Gradle 클라이언트 번들에는 gradle을 지정하고, Maven 클라이언트 번들에는 maven을 지정하고, 종속 항목 라이브러리와 소스 jar만 포함하는 번들에는 default를 지정하거나 이 옵션을 생략합니다. |
--build-system=gradle -bs gradle |
hostname |
검색 문서의 rootURL을 지정합니다.이 옵션은 백엔드 API 프로젝트 app.yaml([YOUR_APP_ID].appspot.com) 내부의 application 항목에서 파생된 기본값과 API의 데코레이터에 정의된 hostname을 재정의합니다.이 옵션은 로컬 테스트를 위해 호스트 이름 localhost를 rootURL로 제공하는 등의 용도로 사용할 수 있습니다. |
--hostname localhost |
format |
REST의 경우 기본값인 rest만 지원되기 때문에 이 옵션은 지정하지 않습니다. |
필요 없습니다. 기본값을 사용합니다. |
output |
출력이 기록되는 디렉터리를 설정합니다. 기본값: 도구가 호출되는 디렉터리 |
--output /mydir-o /mydir |
지원되는 클라이언트 플랫폼
Endpoints 프레임워크 명령줄 도구로 생성된 클라이언트 번들에서 지원되는 플랫폼은 다음과 같습니다.
- 자바 7 이상
- Android 1.6 이상
- App Engine
API에서 OpenAPI 문서 생성
endpointscfg.py 도구는 API 백엔드에서 OpenAPI 문서를 생성하는 명령어를 제공합니다. 명령어 구문은 다음과 같습니다.
lib/endpoints/endpointscfg.py get_openapi_spec
[-h]
[-a APPLICATION]
[--hostname HOSTNAME]
[-o OUTPUT]
service [service ...]
positional arguments:
service Fully qualified service class name.
optional arguments:
-h, --help Show this help message and exit.
-a APPLICATION, --application APPLICATION
The path to the Python App Engine application.
--hostname HOSTNAME Default application hostname, if none is specified for the API service.
-o OUTPUT, --output OUTPUT
The directory to store output files.
--x-google-api-name Add the 'x-google-api-name' field to the generated OpenAPI document.
다음은 echo 사용 예시입니다.
$ lib/endpoints/endpointscfg.py get_openapi_spec --hostname=echo-example.appspot.com main.EchoApi
OpenAPI spec written to ./echov1openapi.json