webdiss/README.markdown

About

A very simple prototype providing an HTTP interface to Redis. It uses hiredis and jansson.

make clean all
./turnip &
curl http://127.0.0.1:7379/SET/hello/world
→ {"SET":[true,"OK"]}
curl http://127.0.0.1:7379/GET/hello
→ {"GET":"world"}

curl -d "GET/hello" http://127.0.0.1:7379/
→ {"GET":"world"}

Features

• GET and POST are supported.
• JSON output, optional JSONP parameter.
• HTTP 1.1 pipelining (45 kqps on a desktop Linux machine.)
• Connects to Redis using a TCP or UNIX socket.

Ideas

• Add meta-data info per key (MIME type in a second key, for instance).
• Add a “raw” output format, and find a way to format multi-bulk data in that format.
• Support PUT, DELETE, HEAD?
• Support pub/sub.
• Disable MULTI/EXEC/DISCARD/WATCH.
• Add logging.
• Enrich config file:
  • Provide timeout (this needs to be added to hiredis first.)
  • Restrict commands by IP range
• Send your ideas using the github tracker or on twitter @yowgi.

HTTP error codes that could be used (although that's not the case at the moment)

• Missing key: 404 Not Found
• Timeout on the redis side: 503 Service Unavailable
• Unknown verb: 405 Method Not Allowed

JSON output

The URI /COMMAND/arg0/arg1/.../argN returns a JSON object with the command as a key and the result as a value.

Examples:

// string
$ curl  http://127.0.0.1:7379/GET/y
{"GET":"41"}

// number
$ curl  http://127.0.0.1:7379/INCR/y
{"INCR":42}

// list
$ curl  http://127.0.0.1:7379/LRANGE/x/0/1
{"LRANGE":["abc","def"]}

// status
$ curl  http://127.0.0.1:7379/TYPE/y
{"TYPE":[true,"string"]}

// error, which is basically a status
$ curl  http://127.0.0.1:7379/MAKE-ME-COFFEE
{"MAKE-ME-COFFEE":[false,"ERR unknown command 'MAKE-ME-COFFEE'"]}


// JSONP callback:
$ curl  "http://127.0.0.1:7379/TYPE/y?jsonp=myCustomFunction"
myCustomFunction({"TYPE":[true,"string"]})