Declare an api.
Example:
api :GET, "/resource_route", "short description",
# File lib/apipie/dsl_definition.rb, line 79 def api(method, path, desc = nil) #:doc: return unless Apipie.active_dsl? _apipie_dsl_data[:api_args] << [method, path, desc] end
# File lib/apipie/dsl_definition.rb, line 70 def def_param_group(name, &block) Apipie.add_param_group(self, name, &block) end
Show some example of what does the described method return.
# File lib/apipie/dsl_definition.rb, line 96 def example(example) #:doc: return unless Apipie.active_dsl? _apipie_dsl_data[:examples] << example.strip_heredoc 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
# File lib/apipie/dsl_definition.rb, line 109 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
Reference other similar method
api :PUT, '/articles/:id' see "articles#create" def update; end
# File lib/apipie/dsl_definition.rb, line 89 def see(*args) return unless Apipie.active_dsl? _apipie_dsl_data[:see] << args end