Stay organized with collections Save and categorize content based on your preferences.
The Endpoints Framework Gradle plugin provides tasks and configurations to build and connect Endpoints Framework for App Engine projects. This plugin provides server-side and client-side support. The server-side plugin generates Discovery documents and OpenAPI specifications from an annotated Endpoints Framework Java project and client libraries. The client-side plugin generates client libraries when a discovery document is available.
Plugin dependencyAdd the Endpoints Framework Gradle plugin dependency by using the following snippet in your build.gradle. The following snippet retrieves the dependency from Maven Central:
Add the server-side Endpoints Framework Gradle plugin using the following snippet in your build.gradle:
Set server-side configuration in your build.gradle by the endpointsServer closure:
The following tasks are exposed for the server-side only.
endpointsClientLibs
This task generates endpoints client libraries based on service classes.
You can use the following properties:
Property DescriptionserviceClasses List of service classes (endpoints classes), this can be inferred from the `web.xml`. clientLibDir Output directory for generated client libraries. hostname To set the root url for the generated client libraries. For example using `hostname = myapp.appspot.com` will result in a default root url of `https://myapp.appspot.com/_ah/api`. endpointsDiscoveryDocs
This task generates discovery documents based on service classes.
You can use the following properties:
Property DescriptionserviceClasses List of service classes (endpoints classes), this can be inferred from the `web.xml`. hostname To set the root url for the generated discovery document. For example using `hostname = myapp.appspot.com` will result in a default root url of `https://myapp.appspot.com/_ah/api`. endpointsOpenApiDocs
This task generates OpenAPI documents based on service classes.
You can use the following properties:
Property DescriptionserviceClasses List of service classes (endpoints classes), this can be inferred from the `web.xml`. hostname To set the root url for the generated OpenAPI document. For example using `hostname = myapp.appspot.com` will result in the `host` url of `https://myapp.appspot.com` and `basePath` as `/_ah/api`. Client-side plugin
To add the client-side Endpoints Framework Gradle plugin using the following in your build.gradle:
apply plugin: 'com.google.cloud.tools.endpoints-framework-client'
Set server-side configuration in your build.gradle by the endpointsClient closure:
endpointsClient {
// client-side properties
}
The client-side plugin doesn't expose tasks like the server-side plugin. Applying the client-side plugin will generate sources according to the following configuration properties.
Property DescriptiondiscoveryDocs A list of discovery docs to use when generating sources. What's next
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["The Endpoints Framework Gradle plugin supports both server-side and client-side operations for App Engine projects, enabling the generation of Discovery documents, OpenAPI specifications, and client libraries."],["To use the server-side plugin, apply `com.google.cloud.tools.endpoints-framework-server` in your `build.gradle`, and configure properties like `hostname` within the `endpointsServer` closure."],["The server-side plugin provides tasks like `endpointsClientLibs`, `endpointsDiscoveryDocs`, and `endpointsOpenApiDocs` for generating client libraries, discovery documents, and OpenAPI documents, respectively."],["The client-side plugin, applied via `com.google.cloud.tools.endpoints-framework-client`, generates client sources based on a list of `discoveryDocs`, without exposing any specific tasks."],["The plugin dependency is `com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.2` and is retrieved from Maven Central and you can find more information on the plugins on GitHub."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4