Skip to content

Commit 588be0f

Browse files
frankynfrankyn
authored
Merge pull request #681 from mpoehler/master
Added gradle build configuration for endpoints-framework-v2/backend
2 parents 7c0545b + 56d86e0 commit 588be0f

File tree

2 files changed

+160
-5
lines changed

2 files changed

+160
-5
lines changed

‎appengine/endpoints-frameworks-v2/backend/README.md

+92-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
This sample demonstrates how to use Google Cloud Endpoints Frameworks using
44
Java on App Engine Standard.
55

6-
## Adding the project ID to the sample API code
6+
## Build with Maven
7+
8+
### Adding the project ID to the sample API code
79

810
You must add the project ID obtained when you created your project to the
911
sample's `pom.xml` before you can deploy the code.
@@ -21,19 +23,19 @@ your project ID.
2123

2224
0. Save your changes.
2325

24-
## Building the sample project
26+
### Building the sample project
2527

2628
To build the project:
2729

2830
mvn clean package
2931

30-
## Generating the openapi.json file
32+
### Generating the openapi.json file
3133

3234
To generate the required configuration file `openapi.json`:
3335

3436
mvn exec:java -DGetSwaggerDoc
3537

36-
## Deploying the sample API to App Engine
38+
### Deploying the sample API to App Engine
3739

3840
To deploy the sample API:
3941

@@ -51,7 +53,92 @@ To deploy the sample API:
5153

5254
0. Wait for the upload to finish.
5355

54-
## Sending a request to the sample API
56+
### Sending a request to the sample API
57+
58+
After you deploy the API and its configuration file, you can send requests
59+
to the API.
60+
61+
To send a request to the API, from a command line, invoke the following `cURL`
62+
command:
63+
64+
curl \
65+
-H "Content-Type: application/json" \
66+
-X POST \
67+
-d '{"message":"echo"}' \
68+
https://$PROJECT_ID.appspot.com/_ah/api/echo/v1/echo
69+
70+
You will get a 200 response with the following data:
71+
72+
{
73+
"message": "echo"
74+
}
75+
76+
## Build with gradle
77+
78+
### Adding the project ID to the sample API code
79+
80+
0. Edit the file `build.gradle`.
81+
82+
0. For `def projectId = 'YOUR_PROJECT_ID'`, replace the value `YOUR_PROJECT_ID` with
83+
your project ID.
84+
85+
0. Edit the file `src/main/java/com/example/echo/Echo.java
86+
87+
0. Replace the value `YOUR-PROJECT-ID` with your project ID.
88+
89+
0. Save your changes.
90+
91+
### Building the sample project
92+
93+
To build the project use:
94+
95+
gradle build
96+
97+
<details>
98+
<summary>more details</summary>
99+
The project contains the standard java and war plugins and in addition to that it contains the following plugins:
100+
https://github.com/GoogleCloudPlatform/endpoints-framework-gradle-plugin for the endpoint related tasks and
101+
https://github.com/GoogleCloudPlatform/app-gradle-plugin for the appengine standard related tasks.
102+
103+
Check the links for details about the available Plugin Goals and Parameters.
104+
</details>
105+
106+
### Generating the openapi.json file
107+
108+
To generate the required configuration file `openapi.json`:
109+
110+
gradle endpointsOpenApiDocs
111+
112+
This results in a file in build/endpointsOpenApiDocs/openapi.json
113+
114+
### Deploying the sample API to App Engine
115+
116+
To deploy the sample API:
117+
118+
0. Invoke the `gcloud` command to deploy the API configuration file:
119+
120+
gcloud service-management deploy build/endpointsOpenApiDocs/openapi.json
121+
122+
0. Deploy the API implementation code by invoking:
123+
124+
gradle appengineDeploy
125+
126+
The first time you upload a sample app, you may be prompted to authorize the
127+
deployment. Follow the prompts: when you are presented with a browser window
128+
containing a code, copy it to the terminal window.
129+
130+
<details>
131+
<summary>ERROR: (gcloud.app.deploy) The current Google Cloud project [...] does not contain an App Engine application.</summary>
132+
If you create a fresh cloud project that doesn't contain a appengine application you may receive this Error:
133+
134+
ERROR: (gcloud.app.deploy) The current Google Cloud project [...] does not contain an App Engine application. Use `gcloud app create` to initialize an App Engine application within the project.
135+
136+
In that case just execute `gcloud app create`, you will be asked to select a region and the app will be created. Then run gradle appengineDeploy again.
137+
</details>
138+
139+
0. Wait for the upload to finish.
140+
141+
### Sending a request to the sample API
55142

56143
After you deploy the API and its configuration file, you can send requests
57144
to the API.

‎appengine/endpoints-frameworks-v2/backend/build.gradle

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
// Copyright 2017 Google Inc.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.import org.apache.tools.ant.filters.ReplaceTokens
14+
15+
buildscript {
16+
repositories {
17+
mavenCentral()
18+
}
19+
20+
dependencies {
21+
classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:+'
22+
classpath 'com.google.cloud.tools:appengine-gradle-plugin:+'
23+
}
24+
}
25+
26+
repositories {
27+
maven {
28+
url 'https://maven-central.storage.googleapis.com'
29+
}
30+
jcenter()
31+
mavenCentral()
32+
}
33+
34+
task wrapper(type: Wrapper) {
35+
gradleVersion = '3.5'
36+
}
37+
38+
def projectId = 'YOUR_PROJECT_ID'
39+
40+
apply plugin: 'java'
41+
apply plugin: 'war'
42+
apply plugin: 'com.google.cloud.tools.endpoints-framework-server'
43+
apply plugin: 'com.google.cloud.tools.appengine'
44+
45+
dependencies {
46+
// For real projects: use concrete versions here instead of the '+' to make your build consistent
47+
compile 'com.google.endpoints:endpoints-framework:+'
48+
compile 'com.google.endpoints:endpoints-management-control-appengine:+'
49+
compile 'com.google.endpoints:endpoints-framework-auth:+'
50+
}
51+
52+
endpointsServer {
53+
// Endpoints Framework Plugin server-side configuration
54+
hostname = "echo-api.endpoints.${projectId}.cloud.goog"
55+
}
56+
57+
sourceCompatibility = 1.7 // App Engine Standard uses Java 7
58+
targetCompatibility = 1.7 // App Engine Standard uses Java 7
59+
60+
// this replaces the ${endpoints.project.id} in appengine-web.xml and web.xml
61+
task replaceProjectId(type: Copy) {
62+
from 'src/main/webapp/WEB-INF/'
63+
include '*.xml'
64+
into 'build/exploded-backend/WEB-INF'
65+
expand(endpoints:[project:[id:projectId]])
66+
filteringCharset = 'UTF-8'
67+
}
68+
assemble.dependsOn replaceProjectId

0 commit comments

Comments
 (0)