Class: SwaggerDocsGenerator::Configuration

Inherits:

Object

• Object
• SwaggerDocsGenerator::Configuration

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:

• https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

Instance Attribute Summary

• #base_path ⇒ Object

  Accessors with default value.

• #cleanning ⇒ Object

  Accessors with default value.

• #compress ⇒ Object

  Accessors with default value.

• #consumes ⇒ Object

  Accessors without default value.

• #definitions ⇒ Object

  Accessors without default value.

• #doc_class ⇒ Object

  Accessors without default value.

• #doc_folder ⇒ Object

  Accessors without default value.

• #external_docs ⇒ Object

  Accessors without default value.

• #host ⇒ Object

  Accessors without default value.

• #produces ⇒ Object

  Accessors without default value.

• #schemes ⇒ Object

  Accessors without default value.

• #security ⇒ Object

  Accessors without default value.

• #sort ⇒ Object

  Accessors with default value.

• #swagger ⇒ Object

  Accessors with default value.

Instance Method Summary

• #initialize ⇒ Configuration constructor

  Initalize default value (and requried) for json swagger file.

Constructor Details

#initialize ⇒ Configuration

Initalize default value (and requried) for json swagger file

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

def initialize
  @swagger = '2.0'
  @base_path = '/'
  @cleanning = true
  @compress = false
  @sort = 'tag'
end

Instance Attribute Details

#base_path ⇒ Object

Accessors with default value

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

def base_path
  @base_path
end

#cleanning ⇒ Object

Accessors with default value

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

def cleanning
  @cleanning
end

#compress ⇒ Object

Accessors with default value

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

def compress
  @compress
end

#consumes ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def consumes
  @consumes
end

#definitions ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def definitions
  @definitions
end

#doc_class ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def doc_class
  @doc_class
end

#doc_folder ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def doc_folder
  @doc_folder
end

#external_docs ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def external_docs
  @external_docs
end

#host ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def host
  @host
end

#produces ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def produces
  @produces
end

#schemes ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def schemes
  @schemes
end

#security ⇒ Object

Accessors without default value

# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 25

def security
  @security
end

#sort ⇒ Object

Accessors with default value

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

def sort
  @sort
end

#swagger ⇒ Object

Accessors with default value

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

def swagger
  @swagger
end