Module: RspecApiDocs

Defined in:
lib/rspec_api_docs.rb,
lib/rspec_api_docs/dsl.rb,
lib/rspec_api_docs/after.rb,
lib/rspec_api_docs/config.rb,
lib/rspec_api_docs/version.rb,
lib/rspec_api_docs/formatter.rb,
lib/rspec_api_docs/rake_task.rb,
lib/rspec_api_docs/dsl/doc_proxy.rb,
lib/rspec_api_docs/dsl/request_store.rb,
lib/rspec_api_docs/after/type_checker.rb,
lib/rspec_api_docs/formatter/resource.rb,
lib/rspec_api_docs/resource_collection.rb,
lib/rspec_api_docs/formatter/resource/example.rb,
lib/rspec_api_docs/formatter/resource/parameter.rb,
lib/rspec_api_docs/formatter/renderer/json_renderer.rb,
lib/rspec_api_docs/formatter/renderer/slate_renderer.rb,
lib/rspec_api_docs/formatter/resource/response_field.rb,
lib/rspec_api_docs/formatter/renderer/raddocs_renderer.rb,
lib/rspec_api_docs/formatter/renderer/json_renderer/name.rb,
lib/rspec_api_docs/formatter/renderer/raddocs_renderer/link.rb,
lib/rspec_api_docs/formatter/resource/example/deep_hash_set.rb,
lib/rspec_api_docs/formatter/resource/example/request_headers.rb,
lib/rspec_api_docs/formatter/renderer/json_renderer/example_serializer.rb,
lib/rspec_api_docs/formatter/renderer/json_renderer/resource_serializer.rb,
lib/rspec_api_docs/formatter/renderer/raddocs_renderer/index_serializer.rb,
lib/rspec_api_docs/formatter/renderer/raddocs_renderer/resource_serializer.rb

Overview

The base module of the gem.

Defined Under Namespace

Modules: After, Dsl, Renderer Classes: Config, Formatter, RakeTask, Resource, ResourceCollection

Constant Summary collapse

METADATA_NAMESPACE =
:rspec_api_docs
BaseError =
Class.new(StandardError)
UndocumentedParameter =
Class.new(BaseError)
VERSION =
'1.1.0'
UnknownRenderer =

Unknown renderer configured.

Class.new(BaseError)

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configurationObject

Returns the value of attribute configuration


3
4
5
# File 'lib/rspec_api_docs/config.rb', line 3

def configuration
  @configuration
end

Class Method Details

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

Yields:


10
11
12
13
# File 'lib/rspec_api_docs/config.rb', line 10

def self.configure
  self.configuration ||= Config.new
  yield configuration
end