Skip to content
This repository was archived by the owner on Jun 30, 2023. It is now read-only.

Commit 56a0aaf

Browse files
committed
add brief migration instructions to README
Change-Id: Iaccc04dd8773d9e8405f5c30e4bb74d3507ff47b
1 parent 70a0728 commit 56a0aaf

1 file changed

Lines changed: 38 additions & 1 deletion

File tree

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,49 @@ in the `com.google.endpoints` group:
1414
The main documents for consuming Endpoints can be found at
1515
https://cloud.google.com/endpoints/docs/frameworks/java
1616

17-
## Installing to local maven
17+
## Installing to local Maven
1818

1919
To install test versions to Maven for easier dependency management, simply run:
2020

2121
gradle install
2222

23+
## Migrating from the legacy Endpoints framework
24+
25+
This release replaces the old `appengine-endpoints` artifact. You should replace
26+
the dependency with the `endpoints-framework` artifact from the
27+
`com.google.endpoints` group. In Maven, the new dependency looks like this:
28+
29+
<dependency>
30+
<groupId>com.google.endpoints</groupId>
31+
<artifactId>endpoints-framework</artifactId>
32+
<version>2.0.0-beta.7</version>
33+
</dependency>
34+
35+
In Gradle, the new dependency looks like this:
36+
37+
compile group: 'com.google.endpoints', name: 'endpoints-framework', version: '2.0.0-beta.7'
38+
39+
You also need to update your `web.xml`. Simply replace all instances of
40+
`SystemServiceServlet` with `EndpointsServlet` and replace `/_ah/spi/*` with
41+
`/_ah/api/*`. The new Endpoints configuration should look something like this:
42+
43+
<servlet>
44+
<servlet-name>EndpointsServlet</servlet-name>
45+
<servlet-class>com.google.api.server.spi.EndpointsServlet</servlet-class>
46+
<init-param>
47+
<param-name>services</param-name>
48+
<param-value>com.example.YourEndpoint</param-value>
49+
</init-param>
50+
<init-param>
51+
<param-name>restricted</param-name>
52+
<param-value>false</param-value>
53+
</init-param>
54+
</servlet>
55+
<servlet-mapping>
56+
<servlet-name>EndpointsServlet</servlet-name>
57+
<url-pattern>/_ah/api/*</url-pattern>
58+
</servlet-mapping>
59+
2360
## Contributing
2461

2562
Your contributions are welcome. Please follow the [contributor

0 commit comments

Comments
 (0)