Complemento de Gradle para marcos de trabajo de Endpoints

El complemento de Gradle para Endpoints Framework proporciona tareas y configuraciones para compilar y conectar Endpoints Framework con proyectos de App Engine. Este complemento brinda asistencia al servidor y al cliente. El complemento del servidor genera documentos de descubrimiento y especificaciones de OpenAPI desde un proyecto de Java de Endpoints Framework anotado y bibliotecas cliente. El complemento del lado del cliente genera bibliotecas cliente cuando hay un documento de descubrimiento disponible.

Dependencia del complemento

Agrega la dependencia del complemento de Gradle para Endpoints Framework mediante el fragmento siguiente a tu build.gradle. El fragmento siguiente recupera la dependencia de Maven Central:

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

Complemento del servidor

Agrega el complemento de Gradle para Endpoints Framework del lado del servidor mediante el fragmento siguiente a tu build.gradle:

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

Configura el servidor en tu build.gradle con el cierre endpointsServer:

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

Propiedades y tareas del lado del servidor

Las siguientes tareas se exponen únicamente en el servidor.

endpointsClientLibs

Esta tarea genera bibliotecas cliente de Endpoints basadas en clases de servicios.

Puedes usar las propiedades que aparecen a continuación:

Propiedad	Descripción
serviceClasses	Lista de clases de servicios (clases de Endpoints), esta se puede deducir de `web.xml`.
clientLibDir	Directorio de salida para bibliotecas cliente generadas.
hostname	Para configurar la URL raíz de las bibliotecas cliente generadas. Por ejemplo, si usas `hostname = myapp.appspot.com`, la URL raíz predeterminada será https://myapp.appspot.com/_ah/api`

endpointsDiscoveryDocs

Esta tarea genera documentos de descubrimiento basados en clases de servicios.

Puedes usar las propiedades que aparecen a continuación:

Propiedad	Descripción
serviceClasses	Lista de clases de servicios (clases de Endpoints), esta se puede deducir de `web.xml`.
hostname	Para configurar la URL raíz del documento de descubrimiento generado. Por ejemplo, si usas `hostname = myapp.appspot.com`, la URL raíz predeterminada será https://myapp.appspot.com/_ah/api`

endpointsOpenApiDocs

Esta tarea genera documentos de OpenAPI basados en clases de servicios.

Puedes usar las propiedades que aparecen a continuación:

Propiedad	Descripción
serviceClasses	Lista de clases de servicios (clases de Endpoints), esta se puede deducir de `web.xml`.
hostname	Para configurar la URL raíz del documento de OpenAPI generado. Por ejemplo, si usas `hostname = myapp.appspot.com`, la URL `host` será `https://myapp.appspot.com` y `basePath` como `/_ah/api`.

Complemento del lado del cliente

Si quieres agregar el complemento de Gradle para Endpoints Framework del lado del cliente mediante el uso de lo siguiente en tu build.gradle, sigue estos pasos:

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

Configura el servidor en tu build.gradle con el cierre endpointsClient:

endpointsClient {
  // client-side properties
}

Propiedades del lado del cliente

El complemento del lado del cliente no expone tareas como el complemento del lado del servidor. La aplicación del complemento del cliente generará fuentes de acuerdo con las siguientes propiedades de configuración.

Propiedad	Descripción
discoveryDocs	Una lista de documentos de descubrimiento para usar cuando se generan fuentes.

¿Qué sigue?

• Explora el código del complemento y también informa problemas en GitHub.