README.md

Hello World Google Cloud Endpoints for App Engine

This sample provides an example of a migration from the prior version of Google Cloud Endpoints Frameworks to new Google Cloud Endpoints Frameworks for App Engine using a Discovery Document. Additionally, this sample provides an example of using the new App Engine Maven and Gradle plugins for deploying your Google App Engine Standard applications.

This sample contains comments of how to use the prior Endpoints Frameworks as well. For clarity, the prior Endpoints Frameworks and the new Endpoints Frameworks are denoted as Endpoints Frameworks v1.0 and Endpoints Frameworks v2.0, respectively.

Google Cloud Endpoints Frameworks v2.0 provides new functionality which may require payment and uses an OpenAPI specification. The OpenAPI development process is explained here and a quickstart is provided here.

Products

• Google App Engine Standard

Language

• Java

APIs

• Google Cloud Endpoints Frameworks v2.0
• Google Cloud Endpoints Frameworks v1.0

Build and Deployment Plugins

• Google App Engine Maven plugin
• Google App Engine Gradle plugin

Discovery Document and Client Library Generation Plugins

• Google Cloud Endpoints Frameworks Maven Plugin
• Google Cloud Endpoints Frameworks Gradle Plugin

Setup

1. Change YOUR-PROJECT-ID with your project id in the hostname parameter defined in either the Maven or Gradle build script. Hostname is used when a discovery document is generated.

   • Maven - pom.xml
   • Gradle - build.gradle

2. [Optional]: User Authenticating with Google Accounts in Web Clients

   1. Update the WEB_CLIENT_ID in Constants.java to reflect the web client ID you have registered in the Credentials on Developers Console for OAuth 2.0 client IDs.

   2. Update the value of google.devrel.samples.helloendpoints.CLIENT_ID in base.js to reflect the web client ID you have registered in the Credentials on Developers Console for OAuth 2.0 client IDs.

3. [Optional]: User Authenticating with Google Accounts in other Applications Types

   • Inside Constants.java you will find placeholders for Android applications using Google Accounts client IDs registered in the Credentials on Developers Console for OAuth 2.0 client IDs.

   • These client IDs are used when defining annotation for this sample API found in Greetings.java.

   • You can read more about different user authentication supported here.

4. [Optional]: Use Cloud Endpoints Frameworks v2.0 Maven and Gradle client library generation plugins with Cloud Endpoints Frameworks v1.0.

   • Uncomment Endpoints Frameworks v1.0 sections and comment Endpoints Frameworks v2.0 sections in the following files.

       pom.xml
       build.gradle
       src/main/webapp/WEB-INF/web.xml
     

Build and Deployment

Maven

1. Build a fresh binary by using:

   mvn clean compile

2. Run the application locally at http://localhost:8080 by using:

   mvn appengine:run

3. Explore local server's API explorer by browsing to:

   http://localhost:8080/_ah/api/explorer

4. Generate the discovery document located at target/discovery-docs/helloworld-v1-rest.discovery by using:

   mvn endpoints-framework:discoveryDocs

5. Generate the client library located at target/client-libs/helloworld-v1-java.zip by using:

   mvn endpoints-framework:clientLibs

6. Deploy your application to Google App Engine by using:

   mvn appengine:deploy

Gradle

1. Build a fresh binary by using:

   gradle clean compileJava

2. Run the application locally at http://localhost:8080 by using:

   gradle appengineRun

3. Explore local server's API explorer by browsing to:

   http://localhost:8080/_ah/api/explorer

4. Generate the discovery document located at build/endpointsDiscoveryDocs/helloworld-v1-rest.discovery by using:

   gradle endpointsDiscoveryDocs

5. Generate the client library located at build/endpointsClientLibs/helloworld-v1-java.zip by using:

   gradle endpointsClientLibs

6. Deploy your application to Google App Engine by using:

   gradle appengineDeploy