Plugin do Gradle do Endpoints Framework

O plug-in do Gradle do Endpoints Framework fornece tarefas e configurações para criar e ligar o Endpoints Framework para projetos do App Engine. Este plugin oferece suporte do lado do servidor e do lado do cliente. O plug-in do lado do servidor gera documentos de descoberta e especificações da OpenAPI a partir de um projeto Java do framework Endpoints anotado e bibliotecas cliente. O plug-in do lado do cliente gera bibliotecas de cliente quando está disponível um documento de descoberta.

Dependência de plug-ins

Adicione a dependência do plugin do Gradle do Framework de Endpoints usando o seguinte fragmento no seu build.gradle. O seguinte fragmento obtém a dependência do Maven Central:

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

Plugin do lado do servidor

Adicione o plugin Gradle do framework Endpoints do lado do servidor através do seguinte fragmento no seu build.gradle:

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

Defina a configuração do lado do servidor no seu build.gradle através do endpointsServer fecho:

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

Tarefas e propriedades do lado do servidor

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

endpointsClientLibs

Esta tarefa gera bibliotecas cliente de pontos finais com base nas classes de serviço.

Pode usar as seguintes propriedades:

Propriedade Descrição
serviceClasses Lista de classes de serviço (classes de pontos finais), que pode ser inferida a partir do `web.xml`.
clientLibDir Diretório de saída para bibliotecas de cliente geradas.
hostname Para definir o URL raiz das bibliotecas de cliente geradas. Por exemplo, usar `hostname = myapp.appspot.com` resulta num URL raiz predefinido de `https://myapp.appspot.com/_ah/api`.

endpointsDiscoveryDocs

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

Pode usar as seguintes propriedades:

Propriedade Descrição
serviceClasses Lista de classes de serviço (classes de pontos finais), que pode ser inferida a partir do `web.xml`.
hostname Para definir o URL raiz do documento de descoberta gerado. Por exemplo, usar `hostname = myapp.appspot.com` resulta num URL raiz predefinido de `https://myapp.appspot.com/_ah/api`.

endpointsOpenApiDocs

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

Pode usar as seguintes propriedades:

Propriedade Descrição
serviceClasses Lista de classes de serviço (classes de pontos finais), que pode ser inferida a partir do `web.xml`.
hostname Para definir o URL raiz do documento OpenAPI gerado. Por exemplo, a utilização de `hostname = myapp.appspot.com` resulta no URL `host` de `https://myapp.appspot.com` e `basePath` como `/_ah/api`.

Plugin do lado do cliente

Para adicionar o plug-in Gradle do framework Endpoints do lado do cliente, use o seguinte no ficheiro build.gradle:

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

Defina a configuração do lado do servidor no seu build.gradle através do endpointsClient fecho:

endpointsClient {
  // client-side properties
}

Propriedades do lado do cliente

O plug-in do lado do cliente não expõe tarefas como o plug-in do lado do servidor. A aplicação do plug-in do lado do cliente gera origens de acordo com as seguintes propriedades de configuração.

Propriedade Descrição
discoveryDocs Uma lista de documentos de descoberta a usar quando gerar fontes.

O que se segue?

  • Explore o código do plug-in e comunique problemas no GitHub.