Complemento Maven de Endpoints Framework

El complemento Endpoints Framework Maven proporciona tareas y configuraciones para crear proyectos de Endpoints Framework. Este complemento ofrece asistencia del lado del cliente y del servidor. Los objetivos del lado del servidor generan documentos de descubrimiento y especificaciones de OpenAPI a partir de un proyecto de Java de Endpoints Framework anotado y bibliotecas de cliente. El objetivo del lado del cliente genera bibliotecas de cliente cuando hay disponible un documento de descubrimiento.

Añadir el complemento Endpoints Framework Maven

Añade el complemento Endpoints Framework Maven con el siguiente fragmento de código de complemento a tu pom.xml:

<plugin>
  <groupId>com.google.cloud.tools</groupId>
  <artifactId>endpoints-framework-maven-plugin</artifactId>
  <version>1.0.2</version>
  <configuration>
    <!-- plugin configuration -->
    <hostname>${endpoints.project.id}.appspot.com</hostname>
  </configuration>
</plugin>

Objetivos de complementos

Después de añadir el complemento Endpoints Framework Maven, estarán disponibles los siguientes objetivos de Maven específicos de Endpoints Framework:

Del servidor

Objetivo Descripción
endpoints-framework:clientLibs Genera bibliotecas de cliente.
endpoints-framework:discoveryDocs Genera documentos de descubrimiento.
endpoints-framework:openApiDocs Genera documentos OpenAPI

Del cliente

Objetivo Descripción
endpoints-framework:generateSrc Genera bibliotecas de cliente a partir de documentos de descubrimiento.

Parámetros de objetivo

Cada objetivo tiene parámetros asociados que puede usar. Puedes especificar estos ajustes en pom.xml o en la línea de comandos.

Para configurar estos ajustes en el pom.xml, añade el nombre del parámetro en la sección <configuration>.

También puedes configurar estos ajustes en la línea de comandos siguiendo el patrón -D[USER_PROPERTY]=[PARAMETER_VALUE].

En las siguientes secciones se muestra una lista de los parámetros disponibles para cada objetivo.

endpoints-framework:clientLibs

Este objetivo genera bibliotecas de cliente del lado del servidor.

Parámetro Descripción Propiedad del usuario
clientLibDir Define la ubicación de las bibliotecas de cliente generadas. La ubicación predeterminada se define como `target/client-libs`. endpoints.clientLibDir
serviceClasses Parámetro opcional para proporcionar una lista de nombres de clases de servicio (clases de endpoints). Esto se puede deducir del archivo `web.xml`. endpoints.serviceClasses
webappDir Indica la ubicación del directorio `webapp`. La ubicación predeterminada se define como `src/main/webapp`. endpoints.webappDir
hostname Para definir la URL raíz de las bibliotecas de cliente. Por ejemplo, si usas `hostname = myapp.appspot.com`, se generará una URL raíz predeterminada`https://myapp.appspot.com/_ah/api`. endpoints.hostname

endpoints-framework:discoveryDocs

Este objetivo genera documentos de descubrimiento.

Parámetro Descripción Propiedad del usuario
discoveryDocDir Define una ubicación para los documentos de descubrimiento generados. La ubicación predeterminada es `target/discovery-docs`. endpoints.discoveryDocDir
serviceClasses Parámetro opcional para proporcionar una lista de nombres de clases de servicio (clases de endpoints). Esto se puede deducir del archivo `web.xml`. endpoints.serviceClasses
webappDir Indica la ubicación del directorio `webapp`. La ubicación predeterminada se define como `src/main/webapp`. endpoints.webappDir
hostname Para definir la URL raíz de los documentos de descubrimiento. Por ejemplo, si usas `hostname = myapp.appspot.com`, se generará una URL raíz predeterminada`https://myapp.appspot.com/_ah/api`. endpoints.hostname

endpoints-framework:openApiDocs

Este objetivo genera documentos de OpenAPI.

Parámetro Descripción Propiedad del usuario
openApiDocDir Define una ubicación para los documentos de OpenAPI generados. La ubicación predeterminada es `target/openapi-docs`. endpoints.openApiDocDir
serviceClasses Parámetro opcional para proporcionar una lista de nombres de clases de servicio (clases de endpoints). Esto se puede deducir del archivo `web.xml`. endpoints.serviceClasses
webappDir Indica la ubicación del directorio `webapp`. La ubicación predeterminada se define como `src/main/webapp`. endpoints.webappDir
hostname Para definir la URL raíz de los documentos de OpenAPI. Por ejemplo, si usas `hostname = myapp.appspot.com`, se generará una URL raíz predeterminada`https://myapp.appspot.com/_ah/api`. endpoints.hostname

endpoints-framework:generateSrc

Este objetivo genera fuentes de cliente a partir de documentos de descubrimiento.

Parámetro Descripción Propiedad del usuario
discoveryDocs Define una lista de documentos de descubrimiento. endpoints.discoveryDocs
generatedSrcDir Directorio de salida de las fuentes de la biblioteca de cliente generada. La ubicación predeterminada es `target/generated-sources/`. endpoints.generatedSrcDir

Siguientes pasos

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