Class: R2OAS::AppConfiguration::Swagger::UI

Inherits:

Object

• Object
• R2OAS::AppConfiguration::Swagger::UI

Defined in:

lib/r2-oas/app_configuration/swagger/ui.rb

Constant Summary

DEFAULT_IMAGE =

'swaggerapi/swagger-ui'

DEFAULT_PORT =

'8080'

DEFAULT_EXPOSED_PORT =

'8080/tcp'

DEFAULT_VOLUME =

'/app/swagger.json'

DEFAULT_HOST =

Fixed

'http://localhost'

VALID_OPTIONS_KEYS =

%i[
  image
  port
  exposed_port
  volume
].freeze

Instance Method Summary

• #configure {|_self| ... } ⇒ Object
• #initialize ⇒ UI constructor

  A new instance of UI.

• #url ⇒ Object

Constructor Details

#initialize ⇒ UI

Returns a new instance of UI.

# File 'lib/r2-oas/app_configuration/swagger/ui.rb', line 22

def initialize
  set_default
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Yields:

• (_self)

Yield Parameters:

• _self (R2OAS::AppConfiguration::Swagger::UI) —

  the object that the method was called on

# File 'lib/r2-oas/app_configuration/swagger/ui.rb', line 26

def configure
  yield self
end

#url ⇒ Object

# File 'lib/r2-oas/app_configuration/swagger/ui.rb', line 30

def url
  "#{DEFAULT_HOST}:#{port}"
end