Class: RspecApiDocs::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec_api_docs/config.rb

Overview

Used to control the behaviour of the gem.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfig

Returns a new instance of Config.



24
25
26
27
28
29
30
# File 'lib/rspec_api_docs/config.rb', line 24

def initialize
  @output_dir = 'docs'
  @renderer = :json
  @validate_params = true
  @exclude_request_headers = []
  @exclude_response_headers = []
end

Instance Attribute Details

#exclude_request_headersObject

Returns the value of attribute exclude_request_headers.



17
18
19
# File 'lib/rspec_api_docs/config.rb', line 17

def exclude_request_headers
  @exclude_request_headers
end

#exclude_response_headersObject

Returns the value of attribute exclude_response_headers.



17
18
19
# File 'lib/rspec_api_docs/config.rb', line 17

def exclude_response_headers
  @exclude_response_headers
end

#output_dirObject

Returns the value of attribute output_dir.



17
18
19
# File 'lib/rspec_api_docs/config.rb', line 17

def output_dir
  @output_dir
end

#rendererObject

Returns the value of attribute renderer.



17
18
19
# File 'lib/rspec_api_docs/config.rb', line 17

def renderer
  @renderer
end

#validate_paramsObject

Returns the value of attribute validate_params.



17
18
19
# File 'lib/rspec_api_docs/config.rb', line 17

def validate_params
  @validate_params
end