Module: Apipie::Extractor

Defined in:
lib/apipie/extractor.rb,
lib/apipie/extractor/writer.rb,
lib/apipie/extractor/recorder.rb,
lib/apipie/extractor/collector.rb

Defined Under Namespace

Classes: ActionDescriptionUpdater, Collector, OrderedHash, Recorder, Writer

Class Method Summary collapse

Class Method Details

.apis_from_routes ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'lib/apipie/extractor.rb', line 58

def apis_from_routes
  return @apis_from_routes if @apis_from_routes

  @api_prefix = Apipie.api_base_url.sub(/\/$/,"")
  populate_api_routes
  update_api_descriptions

  @apis_from_routes
end

.call_finished ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/apipie/extractor.rb', line 39

def call_finished
  @collector ||= Collector.new
  if record = call_recorder.record
    @collector.handle_record(record)
  end
end

.call_recorder ⇒ Object 



35
36
37
 
# File 'lib/apipie/extractor.rb', line 35

def call_recorder
  Thread.current[:apipie_call_recorder] ||= Recorder.new
end

.clean_call_recorder ⇒ Object 



46
47
48
 
# File 'lib/apipie/extractor.rb', line 46

def clean_call_recorder
  Thread.current[:apipie_call_recorder] = nil
end

.controller_path(name) ⇒ Object 



68
69
70
 
# File 'lib/apipie/extractor.rb', line 68

def controller_path(name)
  Apipie.api_controllers_paths.detect { |p| p.include?("#{name}_controller.rb") }
end

.logger ⇒ Object 



31
32
33
 
# File 'lib/apipie/extractor.rb', line 31

def logger
  Rails.logger
end

.write_docs ⇒ Object 



50
51
52
 
# File 'lib/apipie/extractor.rb', line 50

def write_docs
  Writer.new(@collector).write_docs if @collector
end

.write_examples ⇒ Object 



54
55
56
 
# File 'lib/apipie/extractor.rb', line 54

def write_examples
  Writer.new(@collector).write_examples if @collector
end