example/greet.md · typeable/servant

git.iko.soy/typeable/servant

on ec3bebe help sign in

typeable/servant/example/greet.md

76 lines 937 B history raw

1POST /greet

2-----------

4**Request Body**:

6``` javascript

8 "msg": "Hello, haskeller!"

10```

12**Response**:

14 - Status code 201

15 - If you use ?capital=true

17``` javascript

18{

19 "msg": "HELLO, HASKELLER"

20}

21```

23 - If you use ?capital=false

25``` javascript

26{

27 "msg": "Hello, haskeller"

28}

29```

31GET /hello/:name

32----------------

34**Captures**:

36- *name*: name of the person to greet

38**GET Parameters**:

40 - capital

41 - **Values**: *true, false*

42 - **Description**: Get the greeting message in uppercase (true) or not (false). Default is false.

45**Response**:

47 - Status code 200

48 - If you use ?capital=true

50``` javascript

51{

52 "msg": "HELLO, HASKELLER"

53}

54```

56 - If you use ?capital=false

58``` javascript

59{

60 "msg": "Hello, haskeller"

61}

62```

64DELETE /greet/:greetid

65----------------------

67**Captures**:

69- *greetid*: identifier of the greet msg to remove

71**Response**:

73 - Status code 204

74 - No response body