-
Notifications
You must be signed in to change notification settings - Fork 3
/
apiary.apib
270 lines (173 loc) · 5.7 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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
FORMAT: 1A
HOST: http://rails5-api-base.herokuapp.com
# API BASE
Rails Api Base is a boilerplate project for JSON RESTful APIs. It follows the community best practices in terms of standards, security and maintainability, integrating a variety of testing and code quality tools.
## Users Collection [/api/v1/users]
### Sign Up [POST]
+ Request (application/json)
+ Attributes
+ user (Profile Edition, required)
+ Response 200 (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
expiry: 1489009792
uid: test@test.com
+ Attributes
+ user (Profile Response, required)
+ Response 401
## Current user's profile [/api/v1/user/profile]
### Get current user profile [GET]
+ Request (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
uid: test@test.com
+ Response 200 (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
expiry: 1489009792
uid: test@test.com
+ Attributes
+ user (Profile Response, required)
+ Response 401
### Update current user profile [PUT]
+ Request (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
uid: test@test.com
+ Attributes
+ user (Profile Edition, required)
+ Response 200 (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
expiry: 1489009792
uid: test@test.com
+ Attributes
+ user (Profile Response, required)
## Get other user's profile [/api/v1/users/{id}]
### Get user [GET]
+ Request (application/json)
+ Parameters
+ id (integer, required)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
uid: test@test.com
+ Response 200 (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
expiry: 1489009792
uid: test@test.com
+ Attributes
+ user (User, required)
+ Response 401
## Login [/api/v1/users/sign_in]
### Login [POST]
+ Request (application/json)
+ Body
{
"user":
{
"email": "test@gmail.com",
"password": "password"
}
}
+ Response 200 (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
expiry: 1489009792
uid: test@test.com
+ Attributes
+ user (Profile Response, required)
+ Response 401
## Login with Facebook [/api/v1/user/facebook]
### Login with Facebook [POST]
+ Response 200 (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
uid: test@test.com
+ Attributes
+ user (Profile Response, required)
## Logout [/api/v1/users/sign_out]
### Logout [DELETE]
+ Request (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
expiry: 1489009792
uid: test@test.com
+ Response 200 (application/json)
## Reset password [/api/v1/users/password]
More information of how reset password works: https://github.com/lynndylanhurley/devise_token_auth/wiki/Reset-Password-Flow
### Reset password [POST]
Use this route to send a password reset confirmation email
+ Request (application/json)
+ Body
{
"email": "test@test.com",
"redirect_url": "http://www.example.com"
}
+ Response 200 (application/json)
+ Body
{
"success": true,
"message": "An email has been sent to 'example@mail.com' containing instructions for resetting your password."
}
### Reset password [PUT]
Use this route to change user's passwords
+ Request (application/json)
+ Parameters
+ reset_password_token (string, required)
+ Body
{
"password": "12345678",
"password_confirmation": "12345678"
}
+ Response 200 (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
expiry: 1489009792
uid: test@test.com
+ Attributes (Profile Response)
## Edit reset password [/api/v1/users/password/edit]
### Edit reset password [GET]
This route is the destination URL for password reset confirmation
+ Request (application/json)
+ Parameters
+ reset_password_token (string, required)
+ redirect_url (string)
+ Response 200 (application/json)
+ Headers
access-token: sO2bm_Bpdyoo8r78jZ-fqg
client: QADgNCWRJj0LyRruqzYbBg
expiry: 1489009792
uid: test@test.com
# Data Structures
## Profile Response (object)
+ id: 100 (number)
+ email: test@test.com (string)
+ provider: email, facebook, twitter (enum[string]) - it's way the user logins
+ uid: test@test.com (string) - the provider identifier
+ first_name: John (string)
+ last_name: Doe (string)
+ username: jdoe (string)
+ created_at: 2017-02-23T13:54:33.283Z (string)
## Profile Edition (object)
+ email: test@test.com (string)
+ password: 12345678 (string)
+ first_name: John (string)
+ last_name: Doe (string)
+ username: jdoe (string)
## User (object)
+ email: test@test.com (string)
+ first_name: John (string)
+ last_name: Doe (string)
+ username: jdoe (string)