Declare an api.

Example:

  api :GET, "/resource_route", "short description",

Describe the next method.

Example:

  desc "print hello world"
  def hello_world
    puts "hello world"
  end

Describe possible errors

Example:

  error :desc => "speaker is sleeping", :code => 500
  error 500, "speaker is sleeping"
  def hello_world
    return 500 if self.speaker.sleeping?
    puts "hello world"
  end

Show some example of what does the described method return.

Describe available request/response formats

  formats ['json', 'jsonp', 'xml']

create method api and redefine newly added method

Describe method‘s parameter

Example:

  param :greeting, String, :desc => "arbitrary text", :required => true
  def hello_world(greeting)
    puts greeting
  end

Describe whole resource

Example: api :desc => "Show user profile", :path => "/users/", :version => ‘1.0 - 3.4.2012’ param :id, Fixnum, :desc => "User ID", :required => true desc <<-EOS

  Long description...

EOS