Stay organized with collections Save and categorize content based on your preferences.
The Endpoints Framework Maven plugin provides tasks and configurations to build Endpoints Framework projects. This plugin provides server-side and client-side support. The server-side goals generate Discovery documents and OpenAPI specifications from an annotated Endpoints Framework Java project and client libraries. The client-side goal generates client libraries when a discovery document is available.
Add the Endpoints Framework Maven pluginAdd the Endpoints Framework Maven plugin by using the following plugin snippet to your pom.xml:
After you add the Endpoints Framework Maven plugin, the following Endpoints Framework-specific Maven goals are available:
Server-side Goal Descriptionendpoints-framework:clientLibs Generates client libraries endpoints-framework:discoveryDocs Generates discovery documents endpoints-framework:openApiDocs Generates OpenAPI documents Client-side Goal Description endpoints-framework:generateSrc Generates client libraries from discovery documents. Goal parameters
Each goal has associated parameters that you can use. You can specify these settings in the pom.xml or in the command line.
To configure these settings in the pom.xml, add the parameter name in the <configuration> section.
Alternatively, to configure these settings in the command line, follow the pattern -D[USER_PROPERTY]=[PARAMETER_VALUE].
See the following sections for a list of the parameters that are available for each goal.
endpoints-framework:clientLibs
This goal generates client libraries from the server-side.
Parameter Description User PropertyclientLibDir Define the location of generated client libraries. The default location is defined as `target/client-libs`. endpoints.clientLibDir serviceClasses Optional parameter to provide a List of names of service classes (endpoints classes). This can be inferred from the `web.xml`. endpoints.serviceClasses webappDir Provide the location of the `webapp` directory. The default location is defined as `src/main/webapp`. endpoints.webappDir hostname To set the root url for client libs. For example using `hostname = myapp.appspot.com` will result in a default root url of`https://myapp.appspot.com/_ah/api` endpoints.hostname endpoints-framework:discoveryDocs
This goal generates discovery documents.
Parameter Description User PropertydiscoveryDocDir Define a location for generated discovery documents. The default location is defined as `target/discovery-docs`. endpoints.discoveryDocDir serviceClasses Optional parameter to provide a List of names of service classes (endpoints classes). This can be inferred from the `web.xml`. endpoints.serviceClasses webappDir Provide the location of the `webapp` directory. The default location is defined as `src/main/webapp`. endpoints.webappDir hostname To set the root url for discovery docs. For example using `hostname = myapp.appspot.com` will result in a default root url of`https://myapp.appspot.com/_ah/api` endpoints.hostname endpoints-framework:openApiDocs
This goal generates OpenAPI documents.
Parameter Description User PropertyopenApiDocDir Define a location for generated OpenAPI documents. The default location is defined as `target/openapi-docs`. endpoints.openApiDocDir serviceClasses Optional parameter to provide a List of names of service classes (endpoints classes). This can be inferred from the `web.xml`. endpoints.serviceClasses webappDir Provide the location of the `webapp` directory. The default location is defined as `src/main/webapp`. endpoints.webappDir hostname To set the root url for OpenAPI documents. For example using `hostname = myapp.appspot.com` will result in a default root url of`https://myapp.appspot.com/_ah/api` endpoints.hostname endpoints-framework:generateSrc
This goal generates client sources from discovery documents.
Parameter Description User PropertydiscoveryDocs Define a list of discovery documents. endpoints.discoveryDocs generatedSrcDir Output directory for generated client library sources. Default location is at `target/generated-sources/`. endpoints.generatedSrcDir 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 Maven plugin is used to build Endpoints Framework projects, offering both server-side and client-side support."],["Server-side goals of the plugin generate Discovery documents, OpenAPI specifications, and client libraries from an annotated Endpoints Framework Java project."],["Client-side goals provided by the plugin allow the generation of client libraries when a discovery document is available."],["The plugin can be added to a `pom.xml` file using a specific plugin snippet, including configuration settings like the hostname."],["Each plugin goal (`clientLibs`, `discoveryDocs`, `openApiDocs`, `generateSrc`) has configurable parameters that can be set in the `pom.xml` or the command line, allowing control over output directories and other options."]]],[]]
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