What is KijiREST?
KijiREST provides a REST (Representational State Transfer) interface for Kiji, allowing applications to interact with a Kiji cluster over HTTP by issuing the four standard actions: GET, POST, PUT, and DELETE.
Use this interface to pull data from Kiji tables into other applications, such as web pages making use of predictive modeling data to customize user interactions.
There's an example of a KijiREST client as a RubyGem in the GitHub project kiji-rest-client which can be installed by executing:
gem install kijirest-client
REST Resources
Every REST request is parametrized by a resource path that uniquely identifies a server-side resource. Other optional parameters relevant to the action are specified in the query and body sections of the request. For example, to retrieve row data from the 'users' table, a GET request might look like the following:
GET /v1/instances/dev_instance/tables/users/rows/?eid=[12345]&...
All returned data is modeled as JSON. The appropriate MIME types to accept are application/json for lists, metadata, and all non-row-data.
To make use of the interface, you need to know how to identify the KijiREST resources and what operations can be applied to the resources. This guide describes these items as well as how to setup and run KijiREST in your development and production environments.
KijiREST Open Source Development Project
The kiji-rest project will evolve over time to ensure maximum user and developer benefit. With the release of 1.0, we will provide certain guarantees on the compatibility of clients against the KijiREST versioned server. For more information, please visit the developer wiki page on KijiREST API Compatibility.
KijiREST User Guide
- What is KijiREST?
- Setup
- KijiREST Resources
- KijiREST Operations
- KijiREST Examples