-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
187 lines (132 loc) · 3.58 KB
/
apiary.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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
FORMAT: 1A
HOST: http://juegoarol.es
# Juego A Rol
Public API of the **Juego A Rol** application
# Group Login API
Notes related to the user identification
## Login Endpoint [/login]
### Login into the application [POST]
+ Request (application/json)
{ "username": "mgdelacroix", "password": "secret" }
+ Response 200 (application/json)
{ "token": "my-secret-token" }
## Logout Endpoint [/logout]
### Logout from the application [POST]
+ Request
+ Headers
Authentication: Bearer my-secret-token
+ Response 204
# Group Users API
## Users [/users]
### List all users [GET]
+ Request
+ Headers
Authentication: Bearer my-secret-token
+ Response 200 (application/json)
[
{ "id": 1, "username": "mgdelacroix" },
{ "id": 2, "username": "laparca" }
]
### Create a new user [POST]
+ Request
+ Headers
Authentication: Bearer my-secret-token
+ Body
{ "username": "mgdelacroix" }
+ Response 200 (application/json)
{ "id": 1, "username": "mgdelacroix" }
## User details [/users/{userId}]
### Retrieve user details [GET]
+ Request
+ Headers
Authentication: Bearer my-secret-token
+ Response 200 (application/json)
{ "id": 1, "username": "mgdelacroix" }
### Update user details [PUT]
+ Request (application/json)
+ Headers
Authentication: Bearer my-secret-token
+ Body
{ "username": "mgdelacroix2" }
+ Response 204
### Delete user [DELETE]
+ Request
+ Headers
Authentication: Bearer my-secret-token
+ Response 204
# Group Characters API
## Characters [/characters]
### List all characters [GET]
+ Request
+ Headers
Authentication: Bearer my-secret-token
+ Response 200 (application/json)
[
{
"id": 1,
"name": "Glorfindel",
"owner": {
"id": 1,
"username": "mgdelacroix"
},
"game": 27
}
]
### Create character [POST]
+ Request (application/json)
+ Headers
Authentication: Bearer my-secret-token
+ Body
{ "name": "Glorfindel", "game": 27 }
+ Response 200 (application/json)
[
{
"id": 1,
"name": "Glorfindel",
"owner": {
"id": 1,
"username": "mgdelacroix"
},
"game": 27
},
{
"id": 2,
"name": "Arwen",
"owner": {
"id": 1,
"username": "laurapareja"
},
"game": 27
}
]
## Character details [/characters/{characterId}]
### Obtain character details [GET]
+ Request
+ Headers
Authentication: Bearer my-secret-token
+ Response 200 (application/json)
{
"id": 1,
"name": "Glorfindel",
"owner": {
"id": 1,
"username": "mgdelacroix"
},
"game": 27
}
### Update character details [PUT]
+ Request (application/json)
+ Headers
Authentication: Bearer my-secret-token
+ Body
{
"name": "Gloooorfindel",
"owner": 1,
"game": 27
}
+ Response 204
### Delete character [DELETE]
+ Request
+ Headers
Authentication: Bearer my-secret-token
+ Response 204