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/ai/client.rb,
lib/docit/operation.rb,
lib/docit/ai/doc_writer.rb,
lib/docit/configuration.rb,
lib/docit/ai/groq_client.rb,
lib/docit/ai/gap_detector.rb,
lib/docit/ai/tag_injector.rb,
lib/docit/route_inspector.rb,
lib/docit/ai/configuration.rb,
lib/docit/ai/openai_client.rb,
lib/docit/schema_generator.rb,
lib/docit/ui/base_renderer.rb,
lib/docit/ai/autodoc_runner.rb,
lib/docit/ai/prompt_builder.rb,
lib/docit/schema_definition.rb,
lib/docit/ui/scalar_renderer.rb,
lib/docit/ai/anthropic_client.rb,
lib/docit/ui/swagger_renderer.rb,
lib/docit/ai/scaffold_generator.rb,
lib/docit/ai/doc_block_validator.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,
lib/generators/docit/ai_setup/ai_setup_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: Ai, Builders, DSL, DocFile, Generators, UI Classes: Configuration, Engine, Error, Operation, Registry, RouteInspector, SchemaDefinition, SchemaGenerator, UiController

Constant Summary collapse

VERSION = 
"0.3.1"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



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

def configuration
  @configuration ||= Configuration.new
end

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

Yields:



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

def configure
  yield configuration
end

.define_schema(name, &block) ⇒ Object 



41
42
43
44
45
 
# File 'lib/docit.rb', line 41

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 



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

def reset_configuration!
  @configuration = Configuration.new
end

.reset_schemas! ⇒ Object 



47
48
49
 
# File 'lib/docit.rb', line 47

def reset_schemas!
  @schemas = {}
end

.schemas ⇒ Object 



37
38
39
 
# File 'lib/docit.rb', line 37

def schemas
  @schemas ||= {}
end