Module: Docit

Defined in:
lib/docit.rb,
lib/docit/dsl.rb,
lib/docit/engine.rb,
lib/docit/version.rb,
lib/docit/doc_file.rb,
lib/docit/registry.rb,
lib/docit/operation.rb,
lib/docit/configuration.rb,
lib/docit/route_inspector.rb,
lib/docit/schema_generator.rb,
lib/docit/schema_definition.rb,
app/controllers/docit/ui_controller.rb,
lib/docit/builders/response_builder.rb,
lib/docit/builders/parameter_builder.rb,
lib/docit/builders/request_body_builder.rb,
lib/generators/docit/install/install_generator.rb

Overview

Docit is a decorator-style API documentation gem for Ruby on Rails. It generates OpenAPI 3.0.3 specs from clean DSL macros on your controllers.

Defined Under Namespace

Modules: Builders, DSL, DocFile, Generators Classes: Configuration, Engine, Error, Operation, Registry, RouteInspector, SchemaDefinition, SchemaGenerator, UiController

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



26
27
28
 
# File 'lib/docit.rb', line 26

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



22
23
24
 
# File 'lib/docit.rb', line 22

def configure
  yield configuration
end

.define_schema(name, &block) ⇒ Object 



38
39
40
41
42
 
# File 'lib/docit.rb', line 38

def define_schema(name, &block)
  definition = SchemaDefinition.new(name)
  definition.instance_eval(&block) if block_given?
  schemas[name.to_sym] = definition
end

.reset_configuration! ⇒ Object 



30
31
32
 
# File 'lib/docit.rb', line 30

def reset_configuration!
  @configuration = Configuration.new
end

.reset_schemas! ⇒ Object 



44
45
46
 
# File 'lib/docit.rb', line 44

def reset_schemas!
  @schemas = {}
end

.schemas ⇒ Object 



34
35
36
 
# File 'lib/docit.rb', line 34

def schemas
  @schemas ||= {}
end