Class: OpenapiFirst::Middlewares::ResponseValidation

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_first/middlewares/response_validation.rb

Overview

A Rack middleware to validate requests against an OpenAPI API description. You probably want to use OpenapiFirst::Test instead of this middleware.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app, spec = nil, options = {}) ⇒ ResponseValidation

Returns a new instance of ResponseValidation.

Parameters:

  • spec (String, Symbol, OpenapiFirst::Definition) (defaults to: nil) —

    Path to the OpenAPI file or an instance of Definition. If you pass a Symbol, it will load the OAD registered via ‘OpenapiFirst.register` If you leave this blank, it will load the OAD registered as `:default`

  • options (defaults to: {}) —

    Hash :spec [String, OpenapiFirst::Definition] Path to the OpenAPI file or an instance of Definition.

    This will be deprecated. Please use spec argument instead.

    :raise_error [Boolean] Whether to raise an error if validation fails. default: true



17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/openapi_first/middlewares/response_validation.rb', line 17

def initialize(app, spec = nil, options = {})
  @app = app
  if spec.is_a?(Hash)
    options = spec
    spec = options[:spec]
  end
  @raise = options.fetch(:raise_error, OpenapiFirst.configuration.response_validation_raise_error)

  spec ||= :default
  spec = OpenapiFirst[spec] if spec.is_a?(Symbol)

  @definition = spec.is_a?(Definition) ? spec : OpenapiFirst.load(spec)
end

Instance Attribute Details

#app ⇒ Object (readonly) 



32
33
34
 
# File 'lib/openapi_first/middlewares/response_validation.rb', line 32

def app
  @app
end

Instance Method Details

#call(env) ⇒ Object 



34
35
36
37
38
39
 
# File 'lib/openapi_first/middlewares/response_validation.rb', line 34

def call(env)
  status, headers, body = @app.call(env)
  @definition.validate_response(Rack::Request.new(env), Rack::Response[status, headers, body],
                                raise_error: @raise)
  [status, headers, body]
end