lib/restapi/method_description.rb in restapi-0.0.3 vs lib/restapi/method_description.rb in restapi-0.0.4
- old
+ new
@@ -5,25 +5,25 @@
class Api
attr_accessor :short_description, :api_url, :http_method
- def initialize(args)
- @http_method = args[:method] || args[:http_method] || args[:http]
- @short_description = args[:desc] || args[:short] || args[:description]
- @api_url = create_api_url(args[:path] || args[:url])
+ def initialize(method, path, desc)
+ @http_method = method.to_s
+ @api_url = create_api_url(path)
+ @short_description = desc
end
private
def create_api_url(path)
"#{Restapi.configuration.api_base_url}#{path}"
end
end
- attr_reader :errors, :full_description, :method, :resource, :apis
+ attr_reader :errors, :full_description, :method, :resource, :apis, :examples
def initialize(method, resource, app)
@method = method
@resource = resource
@@ -31,10 +31,11 @@
desc = app.get_description || ''
@full_description = Restapi.markup_to_html(desc)
@errors = app.get_errors
@params_ordered = app.get_params
+ @examples = app.get_examples
parent = @resource.controller.superclass
if parent != ActionController::Base
@parent_resource = parent.controller_name
end
@@ -64,19 +65,19 @@
def doc_url
[
ENV["RAILS_RELATIVE_URL_ROOT"],
Restapi.configuration.doc_base_url,
- "##{@resource._id}/#{@method}"
+ "/#{@resource._id}/#{@method}"
].join
end
def method_apis_to_json
@apis.each.collect do |api|
{
:api_url => api.api_url,
- :http_method => api.http_method,
+ :http_method => api.http_method.to_s,
:short_description => api.short_description
}
end
end
@@ -85,10 +86,11 @@
:doc_url => doc_url,
:name => @method,
:apis => method_apis_to_json,
:full_description => @full_description,
:errors => @errors,
- :params => params_ordered.map(&:to_json).flatten
+ :params => params_ordered.map(&:to_json).flatten,
+ :examples => @examples
}
end
private