REST APIs for the rest of us.
Restivus makes it easy to expose a CSV file as a fully-documented REST API.
This is an experiment to see how DRY an API can be. Down the road, I'd like this library to also generate client SDKs in different languages.
This is a very early release, the code is not stable, tested, or reliable...yet. Use at your own risk, yada yada yada (see LICENSE.txt for the real terms).
gem "restivus", "~> 0.0.3"
or gem install restivus
The Restivus
class inherits from Sinatra::Base
. A Restivus app can be just a few lines of code:
require 'restivus'
class Bank < Restivus
pk "Bank_Name" # defaults to "id"
csv "banklist.csv" # from http://www.fdic.gov/bank/individual/failed/banklist.csv
end
Bank.run! # visit localhost:4567/docs
Right now, Heroku chokes when rendering the docs page, so I'm going to try to use the Stasis gem to generate static docs pages.
Copyright (c) 2012 Alan deLevie. See LICENSE.txt for further details.