Merge pull request GoogleCloudPlatform#676 from GoogleCloudPlatform/update-endpoints-migration-sample

frankyn · web-flow · commit a90e1d7a2f4d · 2017-05-25T07:58:19.000-07:00
[Endpoints Framework] Updating migration sample for endpoints framework plugin GA
diff --git a/appengine/endpoints-frameworks-v2/migration-example/README.md b/appengine/endpoints-frameworks-v2/migration-example/README.md
@@ -35,6 +35,13 @@ process is explained [here][8] and a quickstart is provided [here][9].
 - [Google Cloud Endpoints Frameworks Gradle Plugin][11]
 
 ## 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](pom.xml#L101)
+   - [Gradle - build.gradle](build.gradle#L77)
+
 1. [Optional]: User Authenticating with Google Accounts in Web Clients
 
     1. Update the `WEB_CLIENT_ID` in [Constants.java](src/main/java/com/example/helloendpoints/Constants.java)
@@ -88,6 +95,11 @@ process is explained [here][8] and a quickstart is provided [here][9].
 
     [http://localhost:8080/_ah/api/explorer][13]
 
+1. Generate the discovery document located at
+   `target/discovery-docs/helloworld-v1-rest.discovery` by using:
+
+    `mvn endpoints-framework:discoveryDocs`
+
 1. Generate the client library located at
    `target/client-libs/helloworld-v1-java.zip` by using:
 
@@ -111,6 +123,11 @@ process is explained [here][8] and a quickstart is provided [here][9].
 
     [http://localhost:8080/_ah/api/explorer][13]
 
+1. Generate the discovery document located at
+   `build/endpointsDiscoveryDocs/helloworld-v1-rest.discovery` by using:
+
+   `gradle endpointsDiscoveryDocs`
+
 1. Generate the client library located at
    `build/endpointsClientLibs/helloworld-v1-java.zip` by using:
 
diff --git a/appengine/endpoints-frameworks-v2/migration-example/build.gradle b/appengine/endpoints-frameworks-v2/migration-example/build.gradle
@@ -20,10 +20,10 @@ buildscript {    // Configuration for building
   }
   dependencies {
     // App Engine Gradle plugin
-    classpath 'com.google.cloud.tools:appengine-gradle-plugin:1.3.0'
+    classpath 'com.google.cloud.tools:appengine-gradle-plugin:+'
 
     // Endpoints Frameworks Gradle plugin
-    classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.0-beta9'
+    classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:+'
   }
 }
 // [END buildscript]
@@ -55,7 +55,7 @@ dependencies {
 
   // Endpoints Frameworks v2.0
   // [START endpoints-tools]
-  compile group: 'com.google.endpoints', name: 'endpoints-framework-tools', version: '2.0.7'
+  compile group: 'com.google.endpoints', name: 'endpoints-framework', version: '2.0.7'
   // [END endpoints-tools]
   // End of Endpoints Frameworks v2.0
 }
@@ -71,11 +71,12 @@ appengine {  // App Engine tasks configuration
   }
 }
 
-/* [START endpoints-server]
+// [START endpoints-server]
 endpointsServer {
   // Endpoints Framework Plugin server-side configuration
+  hostname = "YOUR-PROJECT-ID.appspot.com"
 }
-[END endpoints-server] */
+// [END endpoints-server]
 
 group   = 'com.example.helloendpoints' // Generated output GroupId
 version = '1'                          // Version in generated output
diff --git a/appengine/endpoints-frameworks-v2/migration-example/pom.xml b/appengine/endpoints-frameworks-v2/migration-example/pom.xml
@@ -95,9 +95,10 @@ limitations under the License.
             <plugin>
                 <groupId>com.google.cloud.tools</groupId>
                 <artifactId>endpoints-framework-maven-plugin</artifactId>
-                <version>1.0.0-beta5</version>
+                <version>1.0.0</version>
                 <configuration>
                     <!-- plugin configuration -->
+                    <hostname>YOUR-PROJECT-ID.appspot.com</hostname>
                 </configuration>
             </plugin>
             <!-- [END endpoints-frameworks-plugin] -->

Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,10 @@ buildscript { // Configuration for building`
`20`	`20`	`}`
`21`	`21`	`dependencies {`
`22`	`22`	`// App Engine Gradle plugin`
`23`		`- classpath 'com.google.cloud.tools:appengine-gradle-plugin:1.3.0'`
	`23`	`+ classpath 'com.google.cloud.tools:appengine-gradle-plugin:+'`
`24`	`24`
`25`	`25`	`// Endpoints Frameworks Gradle plugin`
`26`		`- classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.0-beta9'`
	`26`	`+ classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:+'`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	`// [END buildscript]`
`@@ -55,7 +55,7 @@ dependencies {`
`55`	`55`
`56`	`56`	`// Endpoints Frameworks v2.0`
`57`	`57`	`// [START endpoints-tools]`
`58`		`- compile group: 'com.google.endpoints', name: 'endpoints-framework-tools', version: '2.0.7'`
	`58`	`+ compile group: 'com.google.endpoints', name: 'endpoints-framework', version: '2.0.7'`
`59`	`59`	`// [END endpoints-tools]`
`60`	`60`	`// End of Endpoints Frameworks v2.0`
`61`	`61`	`}`
`@@ -71,11 +71,12 @@ appengine { // App Engine tasks configuration`
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`
`74`		`-/* [START endpoints-server]`
	`74`	`+// [START endpoints-server]`
`75`	`75`	`endpointsServer {`
`76`	`76`	`// Endpoints Framework Plugin server-side configuration`
	`77`	`+ hostname = "YOUR-PROJECT-ID.appspot.com"`
`77`	`78`	`}`
`78`		`-[END endpoints-server] */`
	`79`	`+// [END endpoints-server]`
`79`	`80`
`80`	`81`	`group = 'com.example.helloendpoints' // Generated output GroupId`
`81`	`82`	`version = '1' // Version in generated output`