Module: Apipie::DSL::Action

Included in:
Concern, Controller
Defined in:
lib/apipie/dsl_definition.rb

Instance Method Summary collapse

Instance Method Details

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

# load paths from routes and don’t provide description

api



98
99
100
101
102
 
# File 'lib/apipie/dsl_definition.rb', line 98

def api(method, path, desc = nil, options={}) #:doc:
  return unless Apipie.active_dsl?
  _apipie_dsl_data[:api] = true
  _apipie_dsl_data[:api_args] << [method, path, desc, options]
end

#api!(desc = nil, options = {}) ⇒ Object

# load paths from routes

api! "short description",



107
108
109
110
111
 
# File 'lib/apipie/dsl_definition.rb', line 107

def api!(desc = nil, options={}) #:doc:
  return unless Apipie.active_dsl?
  _apipie_dsl_data[:api] = true
  _apipie_dsl_data[:api_from_routes] = { :desc => desc, :options =>options }
end

#def_param_group(name, &block) ⇒ Object 



90
91
92
 
# File 'lib/apipie/dsl_definition.rb', line 90

def def_param_group(name, &block)
  Apipie.add_param_group(self, name, &block)
end

#example(example) ⇒ Object

Show some example of what does the described method return.



125
126
127
128
 
# File 'lib/apipie/dsl_definition.rb', line 125

def example(example) #:doc:
  return unless Apipie.active_dsl?
  _apipie_dsl_data[:examples] << example.strip_heredoc
end

#resource_description(options = {}, &block) ⇒ Object

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

Raises:

  • (ArgumentError) 


145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/apipie/dsl_definition.rb', line 145

def resource_description(options = {}, &block) #:doc:
  return unless Apipie.active_dsl?
  raise ArgumentError, "Block expected" unless block_given?

  dsl_data = ResourceDescriptionDsl.eval_dsl(self, &block)
  versions = dsl_data[:api_versions]
  @apipie_resource_descriptions = versions.map do |version|
    Apipie.define_resource_description(self, version, dsl_data)
  end
  Apipie.set_controller_versions(self, versions)
end

#see(*args) ⇒ Object

Reference other similar method

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



118
119
120
121
 
# File 'lib/apipie/dsl_definition.rb', line 118

def see(*args)
  return unless Apipie.active_dsl?
  _apipie_dsl_data[:see] << args
end

#show(show) ⇒ Object

Determine if the method should be included in the documentation



132
133
134
135
 
# File 'lib/apipie/dsl_definition.rb', line 132

def show(show)
  return unless Apipie.active_dsl?
  _apipie_dsl_data[:show] = show
end