Module Apipie::DSL::Action
In: lib/apipie/dsl_definition.rb

Methods

api   api!   def_param_group   example   resource_description   see   show  

Public Instance methods

api(method, path, desc = nil, options={})

# load paths from routes and don‘t provide description api

api!(desc = nil, options={})

# load paths from routes api! "short description",

example(example)

Show some example of what does the described method return.

resource_description(options = {}, &block)

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

see(*args)

Reference other similar method 

  api :PUT, '/articles/:id'
  see "articles#create"
  def update; end
show(show)

Determine if the method should be included in the documentation

[Validate]