Complemento Endpoints Framework Gradle

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

Dependencia de complementos

Añade la dependencia del complemento Endpoints Framework Gradle con el siguiente fragmento en tu archivo build.gradle. El siguiente fragmento obtiene la dependencia de Maven Central:

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

Complemento del lado del servidor

Añade el complemento Gradle de Endpoints Framework del lado del servidor con el siguiente fragmento en tu build.gradle:

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

Defina la configuración del lado del servidor en su build.gradle mediante el cierre endpointsServer:

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

Tareas y propiedades del lado del servidor

Las siguientes tareas solo se exponen del lado del servidor.

endpointsClientLibs

Esta tarea genera bibliotecas de cliente de endpoints basadas en clases de servicio.

Puedes usar las siguientes propiedades:

Propiedad Descripción
serviceClasses Lista de clases de servicio (clases de endpoints). Se puede inferir del archivo `web.xml`.
clientLibDir Directorio de salida de las bibliotecas de cliente generadas.
hostname Para definir la URL raíz de las bibliotecas de 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 servicio.

Puedes usar las siguientes propiedades:

Propiedad Descripción
serviceClasses Lista de clases de servicio (clases de endpoints). Se puede inferir del archivo `web.xml`.
hostname Para definir la URL raíz del documento de descubrimiento generado. Por ejemplo, si usa `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 servicio.

Puedes usar las siguientes propiedades:

Propiedad Descripción
serviceClasses Lista de clases de servicio (clases de endpoints). Se puede inferir del archivo `web.xml`.
hostname Para definir la URL raíz del documento OpenAPI generado. Por ejemplo, si usas `hostname = myapp.appspot.com`, la URL `host` será `https://myapp.appspot.com` y `basePath` será `/_ah/api`.

Complemento del lado del cliente

Para añadir el complemento Gradle de Endpoints Framework del lado del cliente, usa lo siguiente en tu build.gradle:

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

Defina la configuración del lado del servidor en su build.gradle mediante 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. Al aplicar el complemento del lado del cliente, se generarán fuentes según las siguientes propiedades de configuración.

Propiedad Descripción
discoveryDocs Lista de documentos de descubrimiento que se va a usar al generar fuentes.

Siguientes pasos

  • Consulta el código del complemento e informa de los problemas en GitHub.