class RspecApiDocumentation::Writers::JsonIodocsExample

Public Class Methods

new(example, configuration) click to toggle source
# File lib/rspec_api_documentation/writers/json_iodocs_writer.rb, line 52
def initialize(example, configuration)
  @example = example
end

Public Instance Methods

as_json(opts = nil) click to toggle source
# File lib/rspec_api_documentation/writers/json_iodocs_writer.rb, line 75
def as_json(opts = nil)
   {
    :MethodName => description,
    :Synopsis => explanation,
    :HTTPMethod => http_method,
    :URI => (requests.first[:request_path] rescue ""),
    :RequiresOAuth => "N",
    :parameters => parameters
  }
end
method_missing(method, *args, &block) click to toggle source
# File lib/rspec_api_documentation/writers/json_iodocs_writer.rb, line 56
def method_missing(method, *args, &block)
  @example.send(method, *args, &block)
end
parameters() click to toggle source
# File lib/rspec_api_documentation/writers/json_iodocs_writer.rb, line 60
def parameters
  params = []
  if @example.respond_to?(:parameters)
    @example.parameters.map do |param|
      params << {
        "Name" => param[:name],
        "Description" => param[:description],
        "Default" => "",
        "Required" => param[:required] ? "Y" : "N"
      }
    end
  end
  params
end