servant/example/greet.md

84 lines
1.1 KiB
Markdown
Raw Normal View History

#### On proper introductions.
Hello there.
As documentation is usually written for humans, it's often useful to introduce concepts with a few words.
#### This title is below the last
You'll also note that multiple intros are possible.
## POST /greet
#### Request Body:
``` javascript
{
"msg": "Hello, haskeller!"
}
```
#### Response:
- Status code 201
- If you use ?capital=true
``` javascript
{
"msg": "HELLO, HASKELLER"
}
```
- If you use ?capital=false
``` javascript
{
"msg": "Hello, haskeller"
}
```
## GET /hello/:name
#### Captures:
- *name*: name of the person to greet
#### GET Parameters:
- capital
- **Values**: *true, false*
- **Description**: Get the greeting message in uppercase (true) or not (false). Default is false.
#### Response:
- Status code 200
- If you use ?capital=true
``` javascript
{
"msg": "HELLO, HASKELLER"
}
```
- If you use ?capital=false
``` javascript
{
"msg": "Hello, haskeller"
}
```
## DELETE /greet/:greetid
#### Captures:
- *greetid*: identifier of the greet msg to remove
#### Response:
- Status code 204
- No response body