Skip to content
self documentaion for your sinatra app's routes
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
test
.gitignore
README.md
Rakefile
VERSION
app.rb
config.ru

README.md

sinatra-doc

self documentaion for your sinatra app's routes

NOTE: this project is now longer being actively maintained. I recommend you check out a more active (and probably more well-written) project sinatra-docdsl

install

> gem install sinatra-doc 

usage

see the reference implementation app.rb

básicamente above any route you want documented, just add

doc "some description"

or

doc "some description", { hash of params to param descriptions }

afterward a new route /doc will be added to your app that renders these documented routes

an example

> your app.rb

class App < Sinatra::Base
  register Sinatra::Doc

  doc "gets a list of foos"
  get "foos" { ... }

  doc "gets a specific foo", { 
    :id => "identifier for a given foo"
  }
  get "foos/:id" { ... }
end

> GET /doc

sinatra doc

GET foos gets a list of foos

GET foos/:id gets a specific foo
  :id identifier for a given foo

Props

based on an idea @bmizerany proposed in a heroku talk in nyc

TODO

  • rake sinatra::doc #=> à la rails rake:routes
  • clean up rendering of docs

2009 softprops (doug tangren)

Something went wrong with that request. Please try again.