Project

buttless

0.0
No commit activity in last 3 years
No release in over 3 years
buttlesstobinharris/buttlessHomepageDocumentationSource CodeBug TrackerWiki
Buttless gives you a way to quickly flesh out an API in detail. It generates sexy documentation. And, you can quickly run the API and simulate various scenarios without neededing a backend.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
19,940
Stars
3
Forks
0
Watchers
2
 Releases
Current version
0.0.6
Total releases
6
First release
2012-04-01
Latest release
2014-09-14
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2013-02-11
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
jeweler
>= 0
rdoc
>= 0
shoulda
>= 0
simplecov
>= 0

Runtime

activesupport
>= 0
array_stats
>= 0
googlecharts
>= 0
json
>= 0
minitest
>= 0
minitest-reporters
>= 0
pdfkit
>= 0
rake
>= 0
redcarpet
>= 0
rest-client
>= 0
sinatra
>= 0
tilt
>= 0
webmock
>= 0
 Project Readme

Buttless

Design, document and develop against API’s in minutes without a back-end.

I wrote Buttless because Engine Room Apps often have to develop an iPhone app or web site without having the backend API or in place yet. This is pretty common when you’re back-end developers are not in the office, or if you’re waiting for your client’s team to get on to it!

With Buttless, you can do the following pretty quickly:

  1. Define an API (resources, methods, parameters) using a simple YAML file
  2. Define example JSON results that the API would send back
  3. Generate pretty HTML and PDF documents for that defined API, which include usage instructions with CURL
  4. Run a web server which creates a pretend backend for your API, so if you’re an iPhone developer you have something to code against instantly

Getting Started

Install the gem

  gem install buttless

Then go to your usual code folder and type

  buttless my-first-api

Congrats, you’ve just started defining your API, and will be soon able to generate docs and develop against it.

Now to learn how to work with your API.

TODO

  • Make default method GET

Contributing to buttless

  • Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet.
  • Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright © 2012 Tobin Harris. See LICENSE.txt for
further details.