Class: OpenapiFirst::Middlewares::RequestValidation

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

Overview

A Rack middleware to validate requests against an OpenAPI API description. All error responses can be customized via the error_response: option.

Request body validation

  • Returns 415 if the request content-type does not match the OpenAPI description.

  • Returns 400 for invalid JSON, missing required fields, type/enum/schema violations, or readOnly fields.

  • Empty bodies are accepted when the body is optional in the spec.

Parameter validation

Query, path, header, and cookie parameters are validated and type-converted against the spec. Missing required parameters or type/format violations return 400.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RequestValidation.

Parameters:

  • app —

    The parent Rack application

  • 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, Symbol, OpenapiFirst::Definition] Path to the OpenAPI file or an instance of Definition.

    This will be deprecated. Please use spec argument instead.

    :raise_error A Boolean indicating whether to raise an error if validation fails.

    default: false

    :error_response The Class to use for error responses.

    This can be a Symbol-name of an registered error response (:default, :jsonapi)
or it can be set to false to disable returning a response.
default: OpenapiFirst::Plugins::Default::ErrorResponse (Config.default_options.error_response)



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/openapi_first/middlewares/request_validation.rb', line 33

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.request_validation_raise_error)
  @error_response_class = error_response_option(options[:error_response])

  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) 



49
50
51
 
# File 'lib/openapi_first/middlewares/request_validation.rb', line 49

def app
  @app
end

Instance Method Details

#call(env) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/openapi_first/middlewares/request_validation.rb', line 51

def call(env)
  rack_response = nil
  app_called = false
  validated = @definition.validate_request(Rack::Request.new(env), raise_error: @raise) do |v|
    app_called = true
    env[REQUEST] = v
    rack_response = @app.call(env)
  end
  env[REQUEST] = validated
  failure = validated.error
  return @error_response_class.new(failure:).render if failure && @error_response_class
  return rack_response if app_called

  @app.call(env)
end