1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# Grape Syntax for Mustermann
This gem implements the `grape` pattern type for Mustermann.
[](https://github.com/ruby-grape/mustermann-grape/actions?query=workflow%3Atests)
## Overview
**Supported options:**
`capture`, `converters`, `except`, `greedy`, `ignore_unknown_options`, `params`, `space_matches_plus` and `uri_decode`
``` ruby
require 'mustermann/grape'
Mustermann.new('/:id', type: :grape).params('/foo') # => { id: 'foo' }
# Providing params option
Mustermann.new('/:id', type: :grape, params: {"id"=>{:type=>"Integer"}}).params('/1') # => { id: '1'}
Mustermann.new('/:id', type: :grape, params: {"id"=>{:type=>"Integer"}}).params('/foo') # => nil
Mustermann.new('/:id', type: :grape, params: {"id"=>{:type=>"String"}}).params('/foo') # => { id: 'foo'}
```
## Syntax
<table>
<thead>
<tr>
<th>Syntax Element</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>:</b><i>name</i> <i><b>or</b></i> <b>{</b><i>name</i><b>}</b></td>
<td>
Captures anything but a forward slash in a semi-greedy fashion. Capture is named <i>name</i>.
Capture behavior can be modified with <tt>capture</tt> and <tt>greedy</tt> option.
</td>
</tr>
<tr>
<td><b>*</b><i>name</i> <i><b>or</b></i> <b>{+</b><i>name</i><b>}</b></td>
<td>
Captures anything in a non-greedy fashion. Capture is named <i>name</i>.
</td>
</tr>
<tr>
<td><b>*</b> <i><b>or</b></i> <b>{+splat}</b></td>
<td>
Captures anything in a non-greedy fashion. Capture is named splat.
It is always an array of captures, as you can use it more than once in a pattern.
</td>
</tr>
<tr>
<td><b>(</b><i>expression</i><b>)</b></td>
<td>
Enclosed <i>expression</i> is optional.
</td>
</tr>
<tr>
<td><i>expression</i><b>|</b><i>expression</i><b>|</b><i>...</i></td>
<td>
Will match anything matching the nested expressions. May contain any other syntax element, including captures.
</td>
</tr>
<tr>
<td><i>x</i><b>?</b></td>
<td>Makes <i>x</i> optional. For instance, <tt>(foo)?</tt> matches <tt>foo</tt> or an empty string.</td>
</tr>
<tr>
<td><b>/</b></td>
<td>
Matches forward slash. Does not match URI encoded version of forward slash.
</td>
</tr>
<tr>
<td><b>\</b><i>x</i></td>
<td>Matches <i>x</i> or URI encoded version of <i>x</i>. For instance <tt>\*</tt> matches <tt>*</tt>.</td>
</tr>
<tr>
<td><i>any other character</i></td>
<td>Matches exactly that character or a URI encoded version of it.</td>
</tr>
</tbody>
</table>
|
