Module: SwaggerUiEngineRails7

Defined in:
lib/swagger_ui_engine_rails7.rb,
lib/swagger_ui_engine_rails7/engine.rb,
lib/swagger_ui_engine_rails7/version.rb,
lib/swagger_ui_engine_rails7/defaults.rb,
lib/swagger_ui_engine_rails7/configuration.rb,
app/helpers/swagger_ui_engine_rails7/config_parser.rb,
app/helpers/swagger_ui_engine_rails7/auth_config_parser.rb,
app/helpers/swagger_ui_engine_rails7/translation_helper.rb,
app/helpers/swagger_ui_engine_rails7/oauth_config_parser.rb,
app/controllers/swagger_ui_engine_rails7/application_controller.rb,
app/controllers/swagger_ui_engine_rails7/swagger_docs_controller.rb

Defined Under Namespace

Modules: AuthConfigParser, ConfigParser, OauthConfigParser, TranslationHelper Classes: ApplicationController, Configuration, Engine, SwaggerDocsController

Constant Summary collapse

VERSION = 
'1.2.4'.freeze
SWAGGER_UI_VERSION = 
'2.2.10'.freeze
DEFAULTS = 
{
  swagger_url:      'http://petstore.swagger.io/v2/swagger.json',
  doc_expansion:    'none',
  json_editor:      false,
  model_rendering:  'schema',
  request_headers:  false,
  validator_url:    '//online.swagger.io/validator'
}.freeze
OAUTH2_DEFAULTS = 
{
  oauth_app_name: 'your-app-name',
  oauth_client_id: 'your-client-id',
  oauth_client_secret: 'your-client-secret-if-required',
  oauth_realm: 'your-realms',
  oauth_scope_separator: ' ',
  oauth_query_string_params: {}
}.freeze

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



12
13
14
 
# File 'lib/swagger_ui_engine_rails7.rb', line 12

def configuration
  @configuration ||= Configuration.new
end

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

Yields:



16
17
18
 
# File 'lib/swagger_ui_engine_rails7.rb', line 16

def configure
  yield configuration
end