git.iko.soy/servant
on 3bd3eff help sign in
servant/servant-docs/example/greet.md
125 lines 1.7 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:
15- Supported content types are:
17 - `application/json`
19- Example: `application/json`
21```javascript
22"HELLO, HASKELLER"
23```
25#### Response:
27- Status code 201
28- Headers: [("X-Example","1729")]
30- Supported content types are:
32 - `application/json`
34- If you use ?capital=true
36```javascript
37"HELLO, HASKELLER"
38```
40- If you use ?capital=false
42```javascript
43"Hello, haskeller"
44```
46## DELETE /greet/:greetid
48#### Title
50This is some text
52#### Second secton
54And some more
56#### Captures:
58- *greetid*: identifier of the greet msg to remove
61- This endpoint is sensitive to the value of the **unicorns** HTTP header.
63#### Response:
65- Status code 200
66- Headers: []
68- Supported content types are:
70 - `application/json`
72- Response body as below.
74```javascript
75[]
76```
78## GET /hello/:name
80#### Captures:
82- *name*: name of the person to greet
84#### GET Parameters:
86- capital
87 - **Values**: *true, false*
88 - **Description**: Get the greeting message in uppercase (true) or not (false).Default is false.
91#### Response:
93- Status code 200
94- Headers: []
96- Supported content types are:
98 - `application/json`
99 - `text/plain;charset=utf-8`
101- If you use ?capital=true
103```javascript
104"HELLO, HASKELLER"
105```
107- If you use ?capital=true
109```
110"HELLO, HASKELLER"
111```
113- If you use ?capital=false
115```javascript
116"Hello, haskeller"
117```
119- If you use ?capital=false
121```
122"Hello, haskeller"
123```