Maven-Plug-in für Endpoints Framework

Das Maven-Plug-in für Endpoints Framework stellt Aufgaben und Konfigurationen zum Erstellen von Endpoints Framework-Projekten bereit. Dieses Plug-in bietet Unterstützung sowohl auf Server- als auch auf Clientseite. Die serverseitigen Zielvorhaben generieren Discovery-Dokumente und OpenAPI-Spezifikationen über ein annotiertes Endpoints Framework-Java-Projekt sowie Clientbibliotheken. Das clientseitige Zielvorhaben generiert Clientbibliotheken, wenn kein Discovery-Dokument verfügbar ist.

Maven-Plug-in für Endpoints Frameworks hinzufügen

Fügen Sie das Maven-Plug-in für Endpoints Frameworks mithilfe des folgenden Plug-in-Snippets Ihrer Datei pom.xml hinzu.

<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>

Plug-in-Zielvorhaben

Nachdem Sie das Maven-Plug-in für Endpoints Framework hinzugefügt haben, sind die folgenden, für Endpoints Framework-spezifischen Maven-Zielvorhaben verfügbar:

Serverseitig

Zielvorhaben Beschreibung
endpoints-framework:clientLibs Generiert Clientbibliotheken
endpoints-framework:discoveryDocs Generiert Discovery-Dokumente
endpoints-framework:openApiDocs Generiert OpenAPI-Dokumente

Clientseitig

Zielvorhaben Beschreibung
endpoints-framework:generateSrc Generiert Clientbibliotheken aus Discovery-Dokumenten

Parameter der Zielvorhaben

Jedem Ziel sind Parameter zugewiesen, die Sie nutzen können. Sie können diese Einstellungen in pom.xml oder über die Befehlszeile vornehmen.

Zur Konfiguration der Einstellungen in pom.xml fügen Sie den Parameternamen im Abschnitt <configuration> ein.

Zur Konfiguration über die Befehlszeile verwenden Sie das Muster -D[USER_PROPERTY]=[PARAMETER_VALUE].

In den folgenden Abschnitten sind die Parameter aufgeführt, die für jedes Ziel zur Verfügung stehen.

endpoints-framework:clientLibs

Dieses Zielvorhaben generiert serverseitig Clientbibliotheken.

Parameter Beschreibung Nutzereigenschaft
clientLibDir Definiert den Speicherort der generierten Clientbibliotheken. Der Standardspeicherort ist als "target/client-libs" definiert. endpoints.clientLibDir
serviceClasses Optionaler Parameter zur Bereitstellung einer Liste von Dienstklassennamen (Endpoints-Klassen). Dies kann aus der Datei "web.xml" abgeleitet werden. endpoints.serviceClasses
webappDir Speicherort des Verzeichnisses "webapp". Als Standardspeicherort ist "src/main/webapp" festgelegt. endpoints.webappDir
hostname Parameter zur Einstellung der Stamm-URL für Clientbibliotheken. Beispiel: Wenn Sie "hostname = myapp.appspot.com" verwenden, lautet die Stamm-URL "https://myapp.appspot.com/_ah/api". endpoints.hostname

endpoints-framework:discoveryDocs

Dieses Zielvorhaben generiert Discovery-Dokumente.

Parameter Beschreibung Nutzereigenschaft
discoveryDocDir Definiert einen Speicherort für Discovery-Dokumente. Als Standardspeicherort ist "target/discovery-docs" festgelegt. endpoints.discoveryDocDir
serviceClasses Optionaler Parameter zur Bereitstellung einer Liste von Dienstklassennamen (Endpoints-Klassen). Dies kann aus der Datei "web.xml" abgeleitet werden. endpoints.serviceClasses
webappDir Speicherort des Verzeichnisses "webapp". Als Standardspeicherort ist "src/main/webapp" festgelegt. endpoints.webappDir
hostname Einstellung der Stamm-URL für Discovery-Dokumente. Beispiel: Wenn Sie "hostname = myapp.appspot.com" verwenden, lautet die Stamm-URL "https://myapp.appspot.com/_ah/api". endpoints.hostname

endpoints-framework:openApiDocs

Dieses Zielvorhaben generiert OpenAPI-Dokumente.

Parameter Beschreibung Nutzereigenschaft
openApiDocDir Definiert einen Speicherort für generierte OpenAPI-Dokumente. Als Standardspeicherort ist "target/openapi-docs" festgelegt. endpoints.openApiDocDir
serviceClasses Optionaler Parameter zur Bereitstellung einer Liste von Dienstklassennamen (Endpoints-Klassen). Dies kann aus der Datei "web.xml" abgeleitet werden. endpoints.serviceClasses
webappDir Speicherort des Verzeichnisses "webapp". Als Standardspeicherort ist "src/main/webapp" festgelegt. endpoints.webappDir
hostname Einstellung der Stamm-URL für OpenAPI-Dokumente. Beispiel: Wenn Sie "hostname = myapp.appspot.com" verwenden, lautet die Stamm-URL "https://myapp.appspot.com/_ah/api". endpoints.hostname

endpoints-framework:generateSrc

Dieses Zielvorhaben generiert Clientquellen aus Discovery-Dokumenten.

Parameter Beschreibung Nutzereigenschaft
discoveryDocs Definiert eine Liste von Discovery-Dokumenten. endpoints.discoveryDocs
generatedSrcDir Ausgabeverzeichnis für generierte Quellen von Clientbibliotheken. Als Standardspeicherort ist "target/generated-sources/" festgelegt. endpoints.generatedSrcDir

Weitere Informationen

  • Plug-in-Code prüfen und Fehler auf GitHub melden