Skip to content

Latest commit

 

History

History
141 lines (97 loc) · 7.69 KB

README.md

File metadata and controls

141 lines (97 loc) · 7.69 KB
Raw

RESTAPIUnifier

RESTAPIUnifier - lightweight Java library that brings together RESTful APIs under one roof! Eventually making such libraries available for different programming enviornments like Javascript, PHP, Python, etc...

Build status

Overall build status (multiple JDKs) Build Status

JDK 1.7 Build status Build Status

OpenJDK 8 Build status Build Status

Built on CloudBees License

Currently covered by GPLv2. See LICENSE file (https://github.com/neomatrix369/RESTAPIUnifier/blob/master/LICENSE) in root and other directories.

Use the following maven command to format source files with license headers

$ mvn license:format

Use the following maven command to perform license checks on source files

$ mvn license:check

Use the following maven command to remove license headers from source files

$ mvn license:remove

Java 8 Compatibility

Find out how you can also use this logo with your F/OSS projects

Compatibility Badge

JSR 353 - JSON-processing API has been used as part of the implementation of this library.

We are supporters of the @adoptopenjdk and @adoptajsr programs!

Purpose and audience

To simplify the use and maintainence of dependencies on external or internal APIs (RESTful APIs). Create an abstraction layer between your application and APIs from disparate vendors and increase cohesion, reduce coupling.

Developers, OpenSource committers, API vendors, API Service Providers, etc... will benefit from such a library.

IDE

For the java version of the libary, when loading the project into IDEs like Eclipse or IntelliJ please use the pom.xml file within the java sub-folder and not the pom.xml in the root folder.

Powered by IntelliJ IDEA - @JetBrains and we are proud of it - thank you for your support !

Examples implemented using RESTAPIUnifier

Java

C#

  • We have a C# implementation of the Java library which has been written based on the test cases in the Java project, without referring to the model code.
  • Examples are on the way. Credit for this task goes to @angiemai . She spent several hours going through the Java tests and writing tests and implementations in C# during the Yahoo! Europe Hackday in London to accomplish the feat!

Note: each of the examples require their own settings file containing properties. Also most of them expect you to have your API key atleast to access their services. Information for these requirements are mentioned within comments of each if the source codes.

Timeline

  • 21 April 2012: discovery and inception of idea at the Google Hackathon
  •  May 2012: came across Mashery I/O Wraps Client Library Generator (see below)
  • August 2012: continued improving library at hackathon
  • 23 April 2013: came across Import.IO (see below)
  • 24 April 2013: further improvements to library - refactoring, tests, tidying up, etc
  • 27 April 2013: more improvements, added examples in Java & inception of C# version at Yahoo! Hack Europe: London
  • 9 May 2013: University student from Brazil is going to use the RestAPIUnifier for his thesis work (with help from the contributors and his professors).
  • 20 July 2013: Heroku API implementation, OAuth - first steps in place. Won Heroku "star prize" (1st of 5 winners) at Hacked.IO, O2 Indigo, London.
  • 19-22 Sep '13: Socrates UK 2013 - major refactoring, design improvements with help from @Alex (@Mosaic Works), created more opportunities for further collaborations.

Implementations based on the principles behind this idea

You can...

  • ...fork the repo and create a version for your own development environment, and create pull requests.
  • ...comment, suggest design improvements, take the idea to the next level.
  • ...combine it with other interesting ideas, libraries, etc...
  • ...do the above and submit pull requests.
  • ...create new examples of existing APIs which can be accessed through the library.
  • ...as far as file formats are concerned, again follow the existing format illustrated by the code-base of the respective languages i.e. for Java - the existing code-base is a good example.
  • ...please follow the principles illustrated by the Java project
  • ...please use Test-Driven Development (TDD) to spawn out your solutions, ideal a test for each feature / functionality. Behaviour-Driven Development (BDD) based solutions are also welcome.

Getting started

Fork repo into your own organisation using the github.com interface. For further help with using the github.com site please refer to https://help.github.com/.

Clone the github repo on your system:

$ git clone git@github.com:<[your user id]>/RESTAPIUnifier.git

Note: local repo will be refered to by the name 'origin'.

Create a link from the local repo to the remote repo (upstream = parent repo):

$ git remote add upstream git@github.com:neomatrix369/RESTAPIUnifier.git

To push changes from local repo to own github repo:

$ git push origin master

To pull changes from own github repo to local repo:

$ git pull origin master

To pull changes from original remote repo to local repo:

$ git pull upstream master

For further help with git commands, please refer to one of the git cheatsheets at http://bit.ly/YxvRYV.

Resources

RESTful API - https://en.wikipedia.org/wiki/Representational_state_transfer

Quotes

  • Alone we can do so little; together we can do so much - Helen Keller
  • Long live social coding! - @neomatrix369