Sha256: de5fd0ac92cec6c79579a027bf71678e0f8c9a7759179bb1fa82d4b20f8584a7
Contents?: true
Size: 1.56 KB
Versions: 9
Compression:
Stored size: 1.56 KB
Contents
VersionCake.setup do |config|
# Set the version key that clients will send example: `X-API-VERSION: 5`
# config.version_key = 'version'
# Enable Rails versioned filename mapping
# config.rails_view_versioning = true
# Extraction Strategies
# Define how you will accept version from the request.
#
# Defaults to all:
# [:http_accept_parameter, :http_header, :request_parameter, :path_parameter, :query_parameter]
#
# Custom strategy example:
# You can create your own extraction strategy by giving a proc or class that responds to execute:
# ```
# lambda {|request| request.headers["HTTP_X_MY_VERSION"] }
# ```
# or
# ```
# class ExtractorStrategy
# def execute(request)
# request.headers["HTTP_X_MY_VERSION"]
# end
# end
# ```
config.extraction_strategy = [:http_accept_parameter,
:http_header,
:request_parameter,
:path_parameter,
:query_parameter]
# Version when no version in present in the request. If none is
# specified then it will error?
config.missing_version = 3
# Versioned Resources
# Define what server resources are supported, deprecated or obsolete
# Resources listed are priority based upon creation. To version all
# resources you can define a catch all at the bottom of the block.
config.resources do |r|
# r.resource uri_regex, obsolete, deprecated, supported
r.resource %r{renders/*}, [2], [4], (1..5)
end
config.response_strategy = [:http_header]
end
Version data entries
9 entries across 9 versions & 1 rubygems