/
doc.apib
83 lines (53 loc) · 1.3 KB
/
doc.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
FORMAT: 1A
# Messages API
# Authentication [/access_tokens]
## Login user [POST]
+ Request
+ Headers
Content-Type: application/json; charset=utf-8
+ Body
{
"email": "test@example.com",
"password": "password"
}
+ Response 201
+ Headers
Content-Type: application/json; charset=utf-8
+ Body
{
"access_token": "access_token"
}
# Message [/messages]
## Get all messages [GET]
+ Response 401
+ Request
+ Headers
Content-Type: application/json; charset=utf-8
Authorization: Bearer ABC123
+ Response 200
+ Headers
Content-Type: application/json; charset=utf-8
+ Body
[
{
"id": 1,
"content": "Message 1"
}
]
# Message [/messages/{id}]
## Show single message [GET]
+ Parameters
+ id: `1` (number, required) - Id of a message.
+ Response 401
+ Request
+ Headers
Content-Type: application/json;charset=utf-8
Authorization: Bearer ABC123
+ Response 200
+ Headers
Content-Type: application/json; charset=utf-8
+ Body
{
"id": 1,
"content": "Message 1"
}