0.2.0 • Published 7 years ago

antidote-rest-client v0.2.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

antidote-rest-client

An HTTP/HTTPS REST API for AntidoteDB, written in Literate IcedCoffeeScript.

Dependencies

Requires iced-coffee-script installed globally:

  • $ npm install -g iced-coffee-script

Installing using NPM

  • $ npm install -g antidote-rest-client

Installing from Source

  • $ git clone https://github.com/joaomlneto/antidote-rest-client.git
  • $ cd antidote-rest-client
  • $ npm test (optionally, if you want to check everything is OK)
  • $ npm install
  • $ npm start

Then fire up your browser to localhost:3000

Configuring

Configuration is done through the command line. See below the options and default values.

  • Antidote hostname: --antidote:hostname=localhost
  • Antidote port: --antidote:port=8087
  • REST server port: --server:port=3000

REST API

Only implementing a subset of the available CRDTs in Antidote:

  • GET /counter/read/:bucket/:key
  • GET/PUT /counter/increment/:bucket/:key/:amount?
  • GET /integer/read/:bucket/:key
  • GET/PUT /integer/increment/:bucket/:key/:amount?
  • GET/PUT /integer/set/:bucket/:key/:value
  • GET /set/read/:bucket/:key
  • GET/PUT/POST /set/add/:bucket/:key/:elem
  • GET/DELETE /set/remove/:bucket/:key/:elem
  • GET /register/read/:bucket/:key
  • GET/PUT /register/set/:bucket/:key/:value
  • GET /mvregister/read/:bucket/:key
  • GET/PUT /mvregister/set/:bucket/:key/:value