Plug-in Gradle do Endpoints Framework

O plug-in Gradle do Endpoints Framework fornece tarefas e configurações para criar e conectar projetos do Endpoints Framework para App Engine. Esse plug-in é compatível com servidores e clientes. O plug-in no lado do servidor gera documentos de descoberta e especificações de OpenAPI com base em um projeto Java do Endpoints Framework e bibliotecas de cliente. O plug-in no lado do cliente gera bibliotecas de cliente quando um documento de descoberta está disponível.

Dependência do plug-in

Adicione a dependência do plug-in do Gradle do Endpoints Framework usando o seguinte snippet no build.gradle. O snippet a seguir recupera a dependência do Maven Central:

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

Plug-in no lado do servidor

Adicione o plug-in do Gradle do Endpoints Framework no lado do servidor usando o snippet a seguir em build.gradle:

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

Defina a configuração do lado do servidor em build.gradle pelo encerramento de endpointsServer:

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

Tarefas e propriedades no lado do servidor

As tarefas a seguir são expostas apenas para o lado do servidor.

endpointsClientLibs

Esta tarefa gera bibliotecas de cliente de endpoint com base em classes de serviço.

Você pode usar as seguintes propriedades:

Propriedade Descrição
serviceClasses Lista de classes de serviço (classes de endpoints) que pode ser inferida por "web.xml".
clientLibDir Diretório de saída para bibliotecas de cliente geradas.
hostname Para definir o URL raiz das bibliotecas cliente geradas. Por exemplo, usar "hostname = myapp.appspot.com" resultará em um URL raiz padrão "https://myapp.appspot.com/_ah/api".

endpointsDiscoveryDocs

Esta tarefa gera documentos de descoberta com base em classes de serviço.

Você pode usar as seguintes propriedades:

Propriedade Descrição
serviceClasses Lista de classes de serviço (classes de endpoints) que pode ser inferida por "web.xml".
hostname Para definir o URL raiz do documento de descoberta gerado. Por exemplo, usar "hostname = myapp.appspot.com" resultará em um URL raiz padrão de "https://myapp.appspot.com/_ah/api".

endpointsOpenApiDocs

Esta tarefa gera documentos de OpenAPI com base em classes de serviço.

Você pode usar as seguintes propriedades:

Propriedade Descrição
serviceClasses Lista de classes de serviço (classes de endpoints) que pode ser inferida por "web.xml".
hostname Para definir o URL raiz do documento de OpenAPI gerado. Por exemplo, usar "hostname = myapp.appspot.com" resultará em um URL "host" de "https://myapp.appspot.com" e "basePath" como "/_ah/api".

Plug-in no lado do cliente

Para adicionar o plug-in do Gradle do Endpoints Framework do lado do cliente, use o seguinte em seu build.gradle:

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

Defina a configuração do lado do servidor em build.gradle pelo encerramento de endpointsClient:

endpointsClient {
  // client-side properties
}

Propriedades no lado do cliente

O plug-in no lado do cliente não expõe tarefas como o plug-in no lado do servidor. Aplicar o plug-in no lado do cliente vai gerar origens de acordo com as propriedades de configuração a seguir.

Propriedade Descrição
discoveryDocs Uma lista de documentos de descoberta a ser usada na geração de origens.

A seguir

  • Confira o código do plug-in e relate problemas no GitHub (em inglês).