git.iko.soy/typeable/servant
on aa64d7a help sign in
typeable/servant/example/greet.md
83 lines 1.1 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
17 "msg": "Hello, haskeller!"
19```
21#### Response:
23 - Status code 201
24 - If you use ?capital=true
26``` javascript
28 "msg": "HELLO, HASKELLER"
30```
32 - If you use ?capital=false
34``` javascript
36 "msg": "Hello, haskeller"
38```
40## GET /hello/:name
42#### Captures:
44- *name*: name of the person to greet
46#### GET Parameters:
48 - capital
49 - **Values**: *true, false*
50 - **Description**: Get the greeting message in uppercase (true) or not (false). Default is false.
53#### Response:
55 - Status code 200
56 - If you use ?capital=true
58``` javascript
60 "msg": "HELLO, HASKELLER"
62```
64 - If you use ?capital=false
66``` javascript
68 "msg": "Hello, haskeller"
70```
72## DELETE /greet/:greetid
74#### Captures:
76- *greetid*: identifier of the greet msg to remove
78#### Response:
80 - Status code 204
81 - No response body