Skip to content

Commit eb1055e

Browse files
committed
Merge pull request ruby-grape#194 from ppadron/add_docs_for_url_param_requirements
Documenting the :requirements option for named route parameters
2 parents 60ea6ca + b5bf0ae commit eb1055e

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.markdown

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,15 @@ class Twitter::API < Grape::API
7777
end
7878
```
7979

80+
Optionally, you can define requirements for your named route parameters using regular expressions. The route will match only if
81+
all requirements are met.
82+
83+
```ruby
84+
get '/show/:id', :requirements => { :id => /[0-9]*/ } do
85+
Tweet.find(params[:id])
86+
end
87+
```
88+
8089
## Mounting
8190

8291
The above sample creates a Rack application that can be run from a rackup *config.ru* file

0 commit comments

Comments
 (0)