API Documentation

Apruary 7, 2015

REST, or expressed in the full form, called Representational State Transfer, has become the standard design architecture for developing web APIs. REST uses HTTP request methods to layer itself into the existing HTTP architecture. There are four options for REST:

  • Get: used to the basic read requests to the server
  • Put: used to fix the existing object on the server
  • Post: used to create a new object on the server
  • Delete: used to remove an object from the server

By creating URL endpoints that take advantages of these operations, the RESTful API is soon built.

API in this case, stands for Application Programming Interface, allowing for publicly exposed methods of an application to be accessed and manipulated outside of the program itself. A common usage of an API is when you wish to obtain data from an application without having to actually visit the application itself. To allow this action to take place, the application has published an API that specifically allows for foreign applications to make calls to its data and return said data to the user from inside of the external application. On the web, this is often done through the use of RESTful URIs.

  • Result/[your query string]:  A single or multiple keyword search on neo4j database
  • Join/[your query string]:
  • DataSource/init/: Initial the data source
  • DataSource/add/: Add the data source on the MetaStore to Presto

  • Result
  • The path is http://54.174.121.196:7654/Result/ Result in this path represents the query string.
    Output parameter: a json format string like {"ID":25,"column":"acceleration","database":"car","keyword":"16","record":"16","table":"cars"}
  • Join
  • The path is http://54.174.121.196:7654/Join/
    Output parameter: a json format string adding the join relult like {"ID":25,"column":"id","database":"car","keyword":"16","record":"816","table":"cars"}],"join":[{"cost":0,"rank":0,"relations":[],"tables":["cars"]}]}