Class: SwaggerDocsGenerator::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_docs_generator/configuration/configuration.rb

Overview

Configuration to swagger json file

This class it's a DSL class. For customize default json file.

Examples:

SwaggerDocsGenerator.configure do |config|
  config.swagger = '2.0.0'
end

SwaggerDocsGenerator.config
=> #<SwaggerDocsGenerator::Configuration:0x007f8ae49138d8
 @swagger='2.0.0'>

See Also:

Constant Summary collapse

SWAGGER = 
'2.0'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Initalize default value (and requried) for json swagger file



27
28
29
30
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 27

def initialize
  @swagger = SWAGGER
  @base_controller = ''
end

Instance Attribute Details

#base_controller ⇒ Object

Returns the value of attribute base_controller.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def base_controller
  @base_controller
end

#base_path ⇒ Object

Returns the value of attribute base_path.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def base_path
  @base_path
end

#consumes ⇒ Object

Returns the value of attribute consumes.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def consumes
  @consumes
end

#definitions ⇒ Object

Returns the value of attribute definitions.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def definitions
  @definitions
end

#external_docs ⇒ Object

Returns the value of attribute external_docs.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def external_docs
  @external_docs
end

#host ⇒ Object

Returns the value of attribute host.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def host
  @host
end

#paths ⇒ Object

Returns the value of attribute paths.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def paths
  @paths
end

#produces ⇒ Object

Returns the value of attribute produces.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def produces
  @produces
end

#schemes ⇒ Object

Returns the value of attribute schemes.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def schemes
  @schemes
end

#security ⇒ Object

Returns the value of attribute security.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def security
  @security
end

#security_definitions ⇒ Object

Returns the value of attribute security_definitions.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def security_definitions
  @security_definitions
end

#swagger ⇒ Object

Returns the value of attribute swagger.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def swagger
  @swagger
end

#tags ⇒ Object

Returns the value of attribute tags.



20
21
22
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 20

def tags
  @tags
end