class Grape::Middleware::Versioner::Param
This middleware sets various version related rack environment variables based on the request parameters and removes that parameter from the request parameters for subsequent middleware and API. If the version substring does not match any potential initialized versions, a 404 error is thrown. If the version substring is not passed the version (highest mounted) version will be used.
Example: For a uri path
/resource?apiver=v1
The following rack env variables are set and path is rewritten to '/resource':
env['api.version'] => 'v1'
Public Instance Methods
before()
click to toggle source
# File lib/grape/middleware/versioner/param.rb, line 30 def before potential_version = Rack::Utils.parse_nested_query(env[Grape::Http::Headers::QUERY_STRING])[paramkey] return if potential_version.nil? throw :error, status: 404, message: '404 API Version Not Found', headers: { Grape::Http::Headers::X_CASCADE => 'pass' } if options[:versions] && !options[:versions].find { |v| v.to_s == potential_version } env[Grape::Env::API_VERSION] = potential_version env[Grape::Env::RACK_REQUEST_QUERY_HASH].delete(paramkey) if env.key? Grape::Env::RACK_REQUEST_QUERY_HASH end
default_options()
click to toggle source
# File lib/grape/middleware/versioner/param.rb, line 22 def default_options { version_options: { parameter: 'apiver'.freeze } } end
Private Instance Methods
paramkey()
click to toggle source
# File lib/grape/middleware/versioner/param.rb, line 40 def paramkey version_options[:parameter] || default_options[:version_options][:parameter] end
version_options()
click to toggle source
# File lib/grape/middleware/versioner/param.rb, line 44 def version_options options[:version_options] end