Module: SwaggerDocsGenerator

Defined in:
lib/swagger_docs_generator/info.rb,
lib/swagger_docs_generator/methods.rb,
lib/swagger_docs_generator/railtie.rb,
lib/swagger_docs_generator/extractor.rb,
lib/swagger_docs_generator/generator.rb,
lib/swagger_docs_generator/metadata/tag.rb,
lib/swagger_docs_generator/metadata/info.rb,
lib/swagger_docs_generator/metadata/path.rb,
lib/swagger_docs_generator/parser/action.rb,
lib/swagger_docs_generator/parser/parser.rb,
lib/swagger_docs_generator/metadata/metadata.rb,
lib/swagger_docs_generator/parser/controller.rb,
lib/swagger_docs_generator/metadata/controller.rb,
lib/swagger_docs_generator/parser/actions/tags.rb,
lib/swagger_docs_generator/metadata/configuration.rb,
lib/swagger_docs_generator/parser/actions/actions.rb,
lib/swagger_docs_generator/parser/actions/summary.rb,
lib/swagger_docs_generator/parser/actions/consumes.rb,
lib/swagger_docs_generator/parser/actions/produces.rb,
lib/swagger_docs_generator/parser/actions/response.rb,
lib/swagger_docs_generator/parser/actions/parameters.rb,
lib/swagger_docs_generator/parser/actions/description.rb,
lib/swagger_docs_generator/configuration/configuration.rb,
lib/generators/swagger_docs_generator/initializer_generator.rb,
lib/swagger_docs_generator/configuration/configuration_info.rb

Overview

:reek:Attribute

Defined Under Namespace

Modules: Actions, Methods Classes: Configuration, ConfigurationInfo, Extractor, Generator, InitializerGenerator, Metadata, MetadataConfiguration, MetadataController, MetadataInfo, MetadataPath, MetadataTag, Parser, ParserAction, ParserController, Railtie

Constant Summary collapse

GEM =

Name to gem

'swagger_docs_generator'
VERSION =

Version to gem

'0.1.0'
AUTHORS =

Authors contributed to gem

['VAILLANT Jeremy'].freeze
EMAILS =

Email to ahuthors

['[email protected]'].freeze
SUMMARY =

Short description

'Swagger UI json file'
DESCRIPTION =

Describe gem

'Generates swagger-ui json file for rails-api'
HOMEPAGE =

Homepage

'https://github.com/Dev-Crea/swagger-docs-generator'
LICENSE =

License

'MIT'

Class Method Summary collapse

Class Method Details

.config ⇒ Object 



37
38
39
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 37

def config
  @config ||= Configuration.new
end

.configure ⇒ Object 



33
34
35
 
# File 'lib/swagger_docs_generator/configuration/configuration.rb', line 33

def configure
  block_given? ? yield(config) : config
end

.configure_info ⇒ Object 



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

def configure_info
  block_given? ? yield(info) : info
end

.info ⇒ Object 



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

def info
  @info ||= ConfigurationInfo.new
end