mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Update the exception of format constraint in routes
Per https://github.com/rails/rails/issues/20264 [ci skip]
This commit is contained in:
parent
75a8973c7a
commit
1307c8d0ea
1 changed files with 2 additions and 0 deletions
|
@ -706,6 +706,8 @@ end
|
|||
|
||||
NOTE: Request constraints work by calling a method on the [Request object](action_controller_overview.html#the-request-object) with the same name as the hash key and then compare the return value with the hash value. Therefore, constraint values should match the corresponding Request object method return type. For example: `constraints: { subdomain: 'api' }` will match an `api` subdomain as expected, however using a symbol `constraints: { subdomain: :api }` will not, because `request.subdomain` returns `'api'` as a String.
|
||||
|
||||
NOTE: There is an exception for the `format` constraint: while it's a method on the Request object, it's also an implicit optional parameter on every path. Segment constraints take precedence and the `format` constraint is only applied as such when enforced through a hash. For example, `get 'foo', constraints: { format: 'json' }` will match `GET /foo` because the format is optional by default. However, you can [use a lambda](#advanced-constraints) like in `get 'foo', constraints: lambda { |req| req.format == :json }` and the route will only match explicit JSON requests.
|
||||
|
||||
### Advanced Constraints
|
||||
|
||||
If you have a more advanced constraint, you can provide an object that responds to `matches?` that Rails should use. Let's say you wanted to route all users on a blacklist to the `BlacklistController`. You could do:
|
||||
|
|
Loading…
Reference in a new issue