Skip to content

Commit 33df5dc

Browse files
author
Clément Denis
committed
Update README.md to reflect the fork status better
1 parent 6cf9a4c commit 33df5dc

1 file changed

Lines changed: 24 additions & 53 deletions

File tree

README.md

Lines changed: 24 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
1-
[![Build Status](https://travis-ci.org/cloudendpoints/endpoints-java.svg?branch=master)](https://travis-ci.org/cloudendpoints/endpoints-java)
2-
[![codecov](https://codecov.io/gh/cloudendpoints/endpoints-java/branch/master/graph/badge.svg)](https://codecov.io/gh/cloudendpoints/endpoints-java)
1+
[![Build Status](https://api.travis-ci.org/AODocs/endpoints-java.svg?branch=master)](https://travis-ci.org/AODocs/endpoints-java)
2+
[![codecov](https://codecov.io/gh/AODocs/endpoints-java/branch/master/graph/badge.svg)](https://codecov.io/gh/AODocs/endpoints-java)
33

44
# Endpoints Java Framework
55

66
The Endpoints Java Framework aims to be a simple solution to assist in creation
77
of RESTful web APIs in Java. This repository provides several artifacts, all
8-
in the `com.google.endpoints` group:
8+
in the `com.aodocs.endpoints` group:
99

1010
1. `endpoints-framework`: The core framework, required for all applications
1111
building Endpoints apps.
12-
2. `endpoints-framework-guice`: An extension for configuring Endpoints using
12+
2. `endpoints-framework-all`: Same as above, but with repackaged dependencies.
13+
3. `endpoints-framework-guice`: An extension for configuring Endpoints using
1314
Guice.
14-
3. `endpoints-framework-tools`: Tools for generating discovery documents,
15+
4. `endpoints-framework-tools`: Tools for generating discovery documents,
1516
Swagger documents, and client libraries.
1617

1718
The main documents for consuming Endpoints can be found at
@@ -22,54 +23,24 @@ https://cloud.google.com/endpoints/docs/frameworks/java
2223
To install test versions to Maven for easier dependency management, simply run:
2324

2425
gradle install
25-
26-
## Migrating from the legacy Endpoints framework
27-
28-
This release replaces the old `appengine-endpoints` artifact. You should replace
29-
the dependency with the `endpoints-framework` artifact from the
30-
`com.google.endpoints` group. In Maven, the new dependency looks like this:
31-
32-
<dependency>
33-
<groupId>com.google.endpoints</groupId>
34-
<artifactId>endpoints-framework</artifactId>
35-
<version>2.0.14</version>
36-
</dependency>
37-
38-
In Gradle, the new dependency looks like this:
39-
40-
compile group: 'com.google.endpoints', name: 'endpoints-framework', version: '2.0.14'
41-
42-
You also need to update your `web.xml`. Simply replace all instances of
43-
`SystemServiceServlet` with `EndpointsServlet` and replace `/_ah/spi/*` with
44-
`/_ah/api/*`. The new Endpoints configuration should look something like this:
45-
46-
<servlet>
47-
<servlet-name>EndpointsServlet</servlet-name>
48-
<servlet-class>com.google.api.server.spi.EndpointsServlet</servlet-class>
49-
<init-param>
50-
<param-name>services</param-name>
51-
<param-value>com.example.Endpoint1,com.example.Endpoint2</param-value>
52-
</init-param>
53-
<init-param>
54-
<param-name>restricted</param-name>
55-
<param-value>false</param-value>
56-
</init-param>
57-
</servlet>
58-
<servlet-mapping>
59-
<servlet-name>EndpointsServlet</servlet-name>
60-
<url-pattern>/_ah/api/*</url-pattern>
61-
</servlet-mapping>
62-
63-
## Repackaging dependencies
64-
65-
The new version of the Endpoints framework does not repackage its dependencies
66-
to hide them. If you run into dependency conflicts and need to do so, we
67-
recommend using the Maven Shade plugin or Gradle Shadow plugin. Full
68-
instructions on doing so are on the [wiki][1].
26+
27+
## Additions to the original project
28+
29+
These are the most notable additions to
30+
[the original project by Google](https://github.com/cloudendpoints/endpoints-java), currently
31+
inactive:
32+
- Allow adding [arbitrary data](https://github.com/AODocs/endpoints-java/pull/20) to generic errors
33+
- [Improve errors](https://github.com/AODocs/endpoints-java/pull/30) on malformed JSON
34+
- Generated Swagger spec is [compatible](https://github.com/AODocs/endpoints-java/pull/34) with
35+
[Cloud Endpoints Portal ](https://cloud.google.com/endpoints/docs/frameworks/dev-portal-overview)
36+
([and](https://github.com/AODocs/endpoints-java/pull/38)
37+
[other](https://github.com/AODocs/endpoints-java/pull/36)
38+
[improvements](https://github.com/AODocs/endpoints-java/pull/37))
39+
40+
Check
41+
[closed PRs](https://github.com/AODocs/endpoints-java/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Aclosed)
42+
for all additions.
6943

7044
## Contributing
7145

72-
Your contributions are welcome. Please follow the [contributor
73-
guidelines](/CONTRIBUTING.md).
74-
75-
[1]: https://github.com/cloudendpoints/endpoints-java/wiki/Vendoring-dependencies
46+
Your contributions are welcome. Please follow the [contributor guidelines](/CONTRIBUTING.md).

0 commit comments

Comments
 (0)