Module: RspecApiDocumentation

Extended by:
ActiveSupport::Autoload
Includes:
ActiveSupport::JSON
Defined in:
lib/rspec_api_documentation.rb,
lib/rspec_api_documentation/dsl.rb,
lib/rspec_api_documentation/curl.rb,
lib/rspec_api_documentation/index.rb,
lib/rspec_api_documentation/example.rb,
lib/rspec_api_documentation/headers.rb,
lib/rspec_api_documentation/railtie.rb,
lib/rspec_api_documentation/client_base.rb,
lib/rspec_api_documentation/test_server.rb,
lib/rspec_api_documentation/open_api/tag.rb,
lib/rspec_api_documentation/api_formatter.rb,
lib/rspec_api_documentation/configuration.rb,
lib/rspec_api_documentation/open_api/info.rb,
lib/rspec_api_documentation/open_api/node.rb,
lib/rspec_api_documentation/open_api/path.rb,
lib/rspec_api_documentation/open_api/root.rb,
lib/rspec_api_documentation/open_api/paths.rb,
lib/rspec_api_documentation/writers/writer.rb,
lib/rspec_api_documentation/open_api/header.rb,
lib/rspec_api_documentation/open_api/helper.rb,
lib/rspec_api_documentation/open_api/schema.rb,
lib/rspec_api_documentation/http_test_client.rb,
lib/rspec_api_documentation/open_api/contact.rb,
lib/rspec_api_documentation/open_api/example.rb,
lib/rspec_api_documentation/open_api/headers.rb,
lib/rspec_api_documentation/open_api/license.rb,
lib/rspec_api_documentation/rack_test_client.rb,
lib/rspec_api_documentation/views/html_index.rb,
lib/rspec_api_documentation/api_documentation.rb,
lib/rspec_api_documentation/oauth2_mac_client.rb,
lib/rspec_api_documentation/open_api/response.rb,
lib/rspec_api_documentation/views/slate_index.rb,
lib/rspec_api_documentation/writers/formatter.rb,
lib/rspec_api_documentation/open_api/operation.rb,
lib/rspec_api_documentation/open_api/parameter.rb,
lib/rspec_api_documentation/open_api/responses.rb,
lib/rspec_api_documentation/views/html_example.rb,
lib/rspec_api_documentation/views/markup_index.rb,
lib/rspec_api_documentation/dsl/endpoint/params.rb,
lib/rspec_api_documentation/views/slate_example.rb,
lib/rspec_api_documentation/views/textile_index.rb,
lib/rspec_api_documentation/writers/html_writer.rb,
lib/rspec_api_documentation/writers/json_writer.rb,
lib/rspec_api_documentation/views/markdown_index.rb,
lib/rspec_api_documentation/views/markup_example.rb,
lib/rspec_api_documentation/writers/index_helper.rb,
lib/rspec_api_documentation/writers/slate_writer.rb,
lib/rspec_api_documentation/views/textile_example.rb,
lib/rspec_api_documentation/dsl/endpoint/set_param.rb,
lib/rspec_api_documentation/views/markdown_example.rb,
lib/rspec_api_documentation/writers/textile_writer.rb,
lib/rspec_api_documentation/writers/markdown_writer.rb,
lib/rspec_api_documentation/writers/open_api_writer.rb,
lib/rspec_api_documentation/open_api/security_schema.rb,
lib/rspec_api_documentation/views/api_blueprint_index.rb,
lib/rspec_api_documentation/writers/append_json_writer.rb,
lib/rspec_api_documentation/writers/json_iodocs_writer.rb,
lib/rspec_api_documentation/views/api_blueprint_example.rb,
lib/rspec_api_documentation/writers/api_blueprint_writer.rb,
lib/rspec_api_documentation/writers/combined_json_writer.rb,
lib/rspec_api_documentation/writers/combined_text_writer.rb,
lib/rspec_api_documentation/open_api/security_definitions.rb,
lib/rspec_api_documentation/writers/general_markup_writer.rb

Overview

Namespace for RspecApiDocumentation

Defined Under Namespace

Modules: DSL, Headers, OpenApi, Views, Writers Classes: ApiDocumentation, ApiFormatter, ClientBase, Configuration, Curl, Example, HttpTestClient, Index, OAuth2MACClient, RackTestClient, Railtie, RequestSaver, TestServer

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



93
94
95
 
# File 'lib/rspec_api_documentation.rb', line 93

def self.configuration
  @configuration ||= Configuration.new
end

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

Configures RspecApiDocumentation

See RspecApiDocumentation::Configuration for more information on configuring.

RspecApiDocumentation.configure do |config|
  config.docs_dir = "doc/api"
end

Yields:



108
109
110
 
# File 'lib/rspec_api_documentation.rb', line 108

def self.configure
  yield configuration if block_given?
end

.documentations ⇒ Object 



97
98
99
 
# File 'lib/rspec_api_documentation.rb', line 97

def self.documentations
  @documentations ||= configuration.map { |config| ApiDocumentation.new(config) }
end