Endpoints Framework Gradle 플러그인

Endpoints Framework Gradle 플러그인은 App Engine용 Endpoints Framework 프로젝트를 빌드하고 연결하기 위한 작업 및 구성을 제공합니다. 이 플러그인은 서버 측 및 클라이언트 측 지원을 제공합니다. 서버 측 플러그인은 주석 처리된 Endpoints Framework 자바 프로젝트 및 클라이언트 라이브러리에서 검색 문서 및 OpenAPI 사양을 생성합니다. 클라이언트 측 플러그인은 검색 문서를 사용할 수 있을 때 클라이언트 라이브러리를 생성합니다.

플러그인 종속 항목

build.gradle에서 다음 스니펫을 사용하여 Endpoints Framework Gradle 플러그인 종속 항목을 추가합니다. 다음 스니펫에서는 Maven Central에서 종속 항목을 검색합니다.

classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.2'

서버 측 플러그인

build.gradle에서 다음 스니펫을 사용하여 서버 측 Endpoints Framework Gradle 플러그인을 추가합니다.

apply plugin: 'com.google.cloud.tools.endpoints-framework-server'

build.gradle에서 서버 측 구성을 endpointsServer로 닫도록 설정합니다.

endpointsServer {
  // Endpoints Framework Plugin server-side configuration
  hostname = "${projectId}.appspot.com"
}

서버 측 작업 및 속성

다음 작업은 서버 측에만 표시됩니다.

endpointsClientLibs

이 작업은 서비스 클래스를 기준으로 Endpoints 클라이언트 라이브러리를 생성합니다.

다음 속성을 사용할 수 있습니다.

속성 설명
serviceClasses 서비스 클래스(Endpoints 클래스) 목록으로, 'web.xml'에서 추론될 수 있습니다.
clientLibDir 생성된 클라이언트 라이브러리의 출력 디렉토리입니다.
hostname 생성된 클라이언트 라이브러리의 루트 URL을 설정합니다. 예를 들어 'hostname = myapp.appspot.com'을 사용하면 기본 루트 URL이 'https://myapp.appspot.com/_ah/api'가 됩니다.

endpointsDiscoveryDocs

이 작업은 서비스 클래스를 기준으로 검색 문서를 생성합니다.

다음 속성을 사용할 수 있습니다.

속성 설명
serviceClasses 서비스 클래스(Endpoints 클래스) 목록으로, 'web.xml'에서 추론할 수 있습니다.
hostname 생성된 검색 문서의 루트 URL을 설정합니다. 예를 들어 'hostname = myapp.appspot.com'을 사용하면 기본 루트 URL이 'https://myapp.appspot.com/_ah/api'가 됩니다.

endpointsOpenApiDocs

이 작업은 서비스 클래스를 기준으로 OpenAPI 문서를 생성합니다.

다음 속성을 사용할 수 있습니다.

속성 설명
serviceClasses 서비스 클래스(Endpoints 클래스) 목록으로, 'web.xml'에서 추론할 수 있습니다.
hostname 생성된 OpenAPI 문서의 루트 URL을 설정합니다. 예를 들어 'hostname = myapp.appspot.com'을 사용하면 'host' URL은 'https://myapp.appspot.com'이 되며 'basePath'는 '/_ah/api'가 됩니다.

클라이언트 측 플러그인

build.gradle에서 다음을 사용하여 클라이언트 측 Endpoints Framework Gradle 플러그인을 추가합니다.

apply plugin: 'com.google.cloud.tools.endpoints-framework-client'

build.gradle에서 서버 측 구성을 endpointsClient 클로저로 설정합니다.

endpointsClient {
  // client-side properties
}

클라이언트 측 속성

클라이언트 측 플러그인은 서버 측 플러그인과 같은 작업을 노출하지 않습니다. 클라이언트 측 플러그인을 적용하면 다음 구성 속성에 따라 소스가 생성됩니다.

속성 설명
discoveryDocs 소스를 생성할 때 사용할 검색 문서 목록입니다.

다음 단계

  • GitHub에서 플러그인 코드를 살펴보고 문제를 보고합니다.