Module: ApidocoDsl

Defined in:
lib/apidoco_dsl.rb,
lib/apidoco_dsl/api.rb,
lib/apidoco_dsl/param.rb,
lib/apidoco_dsl/api_doc.rb,
lib/apidoco_dsl/railtie.rb,
lib/apidoco_dsl/version.rb,
lib/apidoco_dsl/param_group.rb,
lib/apidoco_dsl/documentable.rb,
lib/generators/apidoco_dsl/documentation_generator.rb

Defined Under Namespace

Modules: Documentable, Generators Classes: Api, ApiDoc, Error, Param, ParamGroup, Railtie

Constant Summary collapse

VERSION = 
"0.1.1"
@@api = 
Api.new

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.fetch_docs ⇒ Object 



14
15
16
 
# File 'lib/apidoco_dsl.rb', line 14

def self.fetch_docs
  return @@api.api_docs
end

Instance Method Details

#api_doc(&block) ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/apidoco_dsl.rb', line 27

def api_doc(&block)
  api_doc = ApiDoc.new(@@api)
  api_doc.instance_exec(&block)

  @@api.api_docs << api_doc
end

#def_param_group(group_name, &block) ⇒ Object 



34
35
36
37
38
39
 
# File 'lib/apidoco_dsl.rb', line 34

def def_param_group(group_name, &block)
  param_group = ParamGroup.new(group_name, @@api)
  param_group.instance_exec(&block)

  @@api.param_groups[group_name] = param_group
end

#namespace(namespace) ⇒ Object 



18
19
20
21
 
# File 'lib/apidoco_dsl.rb', line 18

def namespace(namespace)
  @@api.namespace = namespace

end

#resource(resource) ⇒ Object 



23
24
25
 
# File 'lib/apidoco_dsl.rb', line 23

def resource(resource)
  @@api.resource = resource
end