Merge pull request #194 from ppadron/add_docs_for_url_param_requirements

Documenting the :requirements option for named route parameters
ruby-grape · Jun 30, 2012 · eb1055e · eb1055e
2 parents 60ea6ca + b5bf0ae
commit eb1055e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.markdown b/README.markdown
@@ -77,6 +77,15 @@ class Twitter::API < Grape::API
 end
 ```
 
+Optionally, you can define requirements for your named route parameters using regular expressions. The route will match only if
+all requirements are met.
+
+```ruby
+get '/show/:id', :requirements => { :id => /[0-9]*/ } do
+  Tweet.find(params[:id])
+end
+```
+
 ## Mounting
 
 The above sample creates a Rack application that can be run from a rackup *config.ru* file