diff --git a/README.md b/README.md index 79b5d969..08f54039 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ -[![Build Status](https://travis-ci.org/cloudendpoints/endpoints-java.svg?branch=master)](https://travis-ci.org/cloudendpoints/endpoints-java) -[![codecov](https://codecov.io/gh/cloudendpoints/endpoints-java/branch/master/graph/badge.svg)](https://codecov.io/gh/cloudendpoints/endpoints-java) +[![Build Status](https://api.travis-ci.org/AODocs/endpoints-java.svg?branch=master)](https://travis-ci.org/AODocs/endpoints-java) +[![codecov](https://codecov.io/gh/AODocs/endpoints-java/branch/master/graph/badge.svg)](https://codecov.io/gh/AODocs/endpoints-java) # Endpoints Java Framework The Endpoints Java Framework aims to be a simple solution to assist in creation of RESTful web APIs in Java. This repository provides several artifacts, all -in the `com.google.endpoints` group: +in the `com.aodocs.endpoints` group: 1. `endpoints-framework`: The core framework, required for all applications building Endpoints apps. -2. `endpoints-framework-guice`: An extension for configuring Endpoints using +2. `endpoints-framework-all`: Same as above, but with repackaged dependencies. +3. `endpoints-framework-guice`: An extension for configuring Endpoints using Guice. -3. `endpoints-framework-tools`: Tools for generating discovery documents, +4. `endpoints-framework-tools`: Tools for generating discovery documents, Swagger documents, and client libraries. The main documents for consuming Endpoints can be found at @@ -22,54 +23,24 @@ https://cloud.google.com/endpoints/docs/frameworks/java To install test versions to Maven for easier dependency management, simply run: gradle install - -## Migrating from the legacy Endpoints framework - -This release replaces the old `appengine-endpoints` artifact. You should replace -the dependency with the `endpoints-framework` artifact from the -`com.google.endpoints` group. In Maven, the new dependency looks like this: - - - com.google.endpoints - endpoints-framework - 2.0.14 - - -In Gradle, the new dependency looks like this: - - compile group: 'com.google.endpoints', name: 'endpoints-framework', version: '2.0.14' - -You also need to update your `web.xml`. Simply replace all instances of -`SystemServiceServlet` with `EndpointsServlet` and replace `/_ah/spi/*` with -`/_ah/api/*`. The new Endpoints configuration should look something like this: - - - EndpointsServlet - com.google.api.server.spi.EndpointsServlet - - services - com.example.Endpoint1,com.example.Endpoint2 - - - restricted - false - - - - EndpointsServlet - /_ah/api/* - - -## Repackaging dependencies - -The new version of the Endpoints framework does not repackage its dependencies -to hide them. If you run into dependency conflicts and need to do so, we -recommend using the Maven Shade plugin or Gradle Shadow plugin. Full -instructions on doing so are on the [wiki][1]. + +## Additions to the original project + +These are the most notable additions to +[the original project by Google](https://github.com/cloudendpoints/endpoints-java), currently +inactive: +- Allow adding [arbitrary data](https://github.com/AODocs/endpoints-java/pull/20) to generic errors +- [Improve errors](https://github.com/AODocs/endpoints-java/pull/30) on malformed JSON +- Generated Swagger spec is [compatible](https://github.com/AODocs/endpoints-java/pull/34) with +[Cloud Endpoints Portal ](https://cloud.google.com/endpoints/docs/frameworks/dev-portal-overview) +([and](https://github.com/AODocs/endpoints-java/pull/38) +[other](https://github.com/AODocs/endpoints-java/pull/36) +[improvements](https://github.com/AODocs/endpoints-java/pull/37)) + +Check +[closed PRs](https://github.com/AODocs/endpoints-java/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Aclosed) +for all additions. ## Contributing -Your contributions are welcome. Please follow the [contributor -guidelines](/CONTRIBUTING.md). - -[1]: https://github.com/cloudendpoints/endpoints-java/wiki/Vendoring-dependencies +Your contributions are welcome. Please follow the [contributor guidelines](/CONTRIBUTING.md).