Allow to override path for schema matching

Author: kaorukobo

lib/openapi_first.rb

@@ -15,6 +15,10 @@ module OpenapiFirst
 
   # Key in rack to find instance of Request
   REQUEST = 'openapi.request'
+
+  # Key in rack env that stores the alternative path used for schema matching
+  RACK_KEY_PATH_TO_MATCH = 'openapi.path_to_match'
+
   FAILURE = :openapi_first_validation_failure
 
   # @return [Configuration]
@@ -31,6 +35,13 @@ def self.configure
   ERROR_RESPONSES = {} # rubocop:disable Style/MutableConstant
   private_constant :ERROR_RESPONSES
 
+  # Retrieve the path used for schema matching.
+  #
+  # @param [Rack::Request] rack_request
+  def self.get_path_to_match(rack_request)
+    rack_request.env[RACK_KEY_PATH_TO_MATCH] || rack_request.path
+  end
+
   # Register an error response class
   # @param name [Symbol]
   # @param klass [Class] A class that includes / implements OpenapiFirst::ErrorResponse

lib/openapi_first/definition.rb

@@ -45,7 +45,7 @@ def initialize(contents, filepath = nil)
     # @param [Boolean] raise_error Whether to raise an error if validation fails.
     # @return [ValidatedRequest] The validated request object.
     def validate_request(request, raise_error: false)
-      route = @router.match(request.request_method, request.path, content_type: request.content_type)
+      route = @router.match(request.request_method, OpenapiFirst.get_path_to_match(request), content_type: request.content_type)
       if route.error
         ValidatedRequest.new(request, error: route.error)
       else
@@ -62,7 +62,7 @@ def validate_request(request, raise_error: false)
     # @param raise_error [Boolean] Whethir to raise an error if validation fails.
     # @return [ValidatedResponse] The validated response object.
     def validate_response(rack_request, rack_response, raise_error: false)
-      route = @router.match(rack_request.request_method, rack_request.path, content_type: rack_request.content_type)
+      route = @router.match(rack_request.request_method, OpenapiFirst.get_path_to_match(rack_request), content_type: rack_request.content_type)
       return if route.error # Skip response validation for unknown requests
 
       response_match = route.match_response(status: rack_response.status, content_type: rack_response.content_type)

spec/definition_spec.rb

@@ -213,6 +213,20 @@ def build_request(path, method: 'GET')
         ).to be_valid
       end
     end
+
+    context 'with an alternate path used for schema matching' do
+      let(:request) {
+        build_request('/prefix/stuff/42').tap { |req|
+          req.env[OpenapiFirst::RACK_KEY_PATH_TO_MATCH] = '/stuff/42'
+        }
+      }
+
+      it 'returns a valid request' do
+        validated = definition.validate_request(request)
+        expect(validated).to be_valid
+        expect(validated.parsed_path_parameters).to eq({ 'id' => 42 })
+      end
+    end
   end
 
   describe '#validate_response' do
@@ -296,6 +310,21 @@ def build_request(path, method: 'GET')
         end
       end
     end
+
+    context 'with an alternate path used for schema matching' do
+      let(:request) {
+        build_request('/prefix/stuff/42').tap { |req|
+          req.env[OpenapiFirst::RACK_KEY_PATH_TO_MATCH] = '/stuff'
+        }
+      }
+      let(:response) { Rack::Response.new(JSON.generate({ 'id' => 42 }), 200, { 'Content-Type' => 'application/json' }) }
+
+      it 'returns a valid response' do
+        validated = definition.validate_response(request, response)
+        expect(validated).to be_valid
+        expect(validated.parsed_body).to eq({ 'id' => 42 })
+      end
+    end
   end
 
   describe '#routes' do