Gradle-Plug-in für Endpoints Frameworks

Das Gradle-Plug-in für Endpoints Frameworks bietet Aufgaben und Konfigurationen zum Erstellen und Verbinden von Endpoints Frameworks für App Engine-Projekte. Es bietet Unterstützung auf Server- und auf Clientseite. Das serverseitige Plug-in generiert Discovery-Dokumente und OpenAPI-Spezifikationen über ein annotiertes Endpoints Frameworks-Java-Projekt und Clientbibliotheken. Das clientseitige Plug-in generiert Clientbibliotheken, wenn ein Discovery-Dokument verfügbar ist.

Plug-in-Abhängigkeit

Fügen Sie die Abhängigkeit des Gradle-Plug-ins für Endpoints Frameworks mithilfe des folgenden Snippets in Ihrem build.gradle hinzu. Das Snippet ruft die Abhängigkeit von Maven Central ab:

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

Serverseitiges Plug-in

Fügen Sie das serverseitige Gradle-Plug-in für Endpoints Frameworks mithilfe des folgenden Snippets in Ihrem build.gradle hinzu:

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

Legen Sie die serverseitige Konfiguration in build.gradle fest. Dazu setzen Sie bei endpointsServer geschweifte Klammern:

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

Serverseitige Aufgaben und Attribute

Die folgenden Aufgaben beziehen sich nur auf die Serverseite.

endpointsClientLibs

Diese Aufgabe generiert Endpoints-Clientbibliotheken basierend auf Dienstklassen.

Sie können folgende Attribute verwenden:

Attribut Beschreibung
serviceClasses Liste der Dienstklassen (Endpoints-Klassen). Dies kann aus der Datei "web.xml" abgeleitet werden.
clientLibDir Ausgabeverzeichnis für generierte Clientbibliotheken.
hostname Zum Festlegen der Stamm-URL für die generierten Clientbibliotheken. Die Verwendung von "hostname = myapp.appspot.com" führt beispielsweise zur standardmäßigen Stamm-URL "https://myapp.appspot.com/_ah/api".

endpointsDiscoveryDocs

Diese Aufgabe generiert Discovery-Dokumente basierend auf Dienstklassen.

Sie können folgende Attribute verwenden:

Attribut Beschreibung
serviceClasses Liste der Dienstklassen (Endpoints-Klassen). Dies kann aus der Datei "web.xml" abgeleitet werden.
hostname Zum Festlegen der Stamm-URL für das generierte Discovery-Dokument. Die Verwendung von "hostname = myapp.appspot.com" führt beispielsweise zur standardmäßigen Stamm-URL "https://myapp.appspot.com/_ah/api".

endpointsOpenApiDocs

Diese Aufgabe generiert OpenAPI-Dokumente basierend auf Dienstklassen.

Sie können folgende Attribute verwenden:

Attribut Beschreibung
serviceClasses Liste der Dienstklassen (Endpoints-Klassen). Dies kann aus der Datei "web.xml" abgeleitet werden.
hostname Zum Festlegen der Stamm-URL für das generierte OpenAPI-Dokument. Die Verwendung von "hostname = myapp.appspot.com" führt beispielsweise zur "Host"-URL "https://myapp.appspot.com" und dem "basePath" "/_ah/api".

Clientseitiges Plug-in

Fügen Sie das clientseitige Gradle-Plug-in für Endpoints Frameworks hinzu. Dazu verwenden Sie Folgendes in Ihrem build.gradle:

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

Legen Sie die serverseitige Konfiguration in build.gradle fest. Dazu setzen Sie bei endpointsClient geschweifte Klammern:

endpointsClient {
  // client-side properties
}

Clientseitige Attribute

Das clientseitige Plug-in stellt keine Aufgaben wie das serverseitige Plug-in bereit. Die Anwendung des clientseitigen Plug-ins generiert Quellen gemäß den folgenden Konfigurationsattributen.

Attribut Beschreibung
discoveryDocs Eine Liste der Discovery-Dokumente, die beim Generieren von Quellen verwendet werden.

Weitere Informationen

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