git.iko.soy/servant
on a008e08 help sign in
servant/example/greet.md
84 lines 1.2 kB history raw
1#### On proper introductions.
3Hello there.
5As documentation is usually written for humans, it's often useful to introduce concepts with a few words.
7#### This title is below the last
9You'll also note that multiple intros are possible.
11## POST /greet
13#### Request Body:
15``` javascript
16"Hello, haskeller!"
17```
19#### Response:
21 - Status code 201
22 - If you use ?capital=true
24``` javascript
25"HELLO, HASKELLER"
26```
28 - If you use ?capital=false
30``` javascript
31"Hello, haskeller"
32```
34## GET /hello;lang=<value>/:name
36#### Captures:
38- *name*: name of the person to greet
40#### Matrix Parameters**:
42**hello**:
44 - lang
45 - **Values**: *en, sv, fr*
46 - **Description**: Get the greeting message selected language. Default is en.
51#### GET Parameters:
53 - capital
54 - **Values**: *true, false*
55 - **Description**: Get the greeting message in uppercase (true) or not (false).Default is false.
58#### Response:
60 - Status code 200
61 - If you use ?capital=true
63``` javascript
64"HELLO, HASKELLER"
65```
67 - If you use ?capital=false
69``` javascript
70"Hello, haskeller"
71```
73## DELETE /greet/:greetid
75#### Captures:
77- *greetid*: identifier of the greet msg to remove
79#### Response:
81 - Status code 204
82 - No response body