-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
481 lines (389 loc) · 18.9 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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
FORMAT: 1A
HOST: https://bloodflow.herokuapp.com/api
# Bloodflow API
# Group Users
Работа с пользователями
## Users Collection [/users]
### Получение списка пользователей[GET]
+ Request
ready=true&
city=Днепр&
blood=1&
rhesus=+&
phone=+380669181748
+ Response 200 (application/json)
[{
"__v": 0,
"_id": "54c6ffb8faebf193db3b1b63",
"blood": 1,
"city": "Днепропетровск",
"email": "[email protected]",
"firstName": "Герасименко",
"image": "http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328297/jcmz3aye1xun1690o9kh.jpg",
"lastName": "Вячеславович",
"phone": "+380669181748",
"ready": false,
"rhesus": "+",
"secondName": "Роман"
},{
"__v": 0,
"_id": "54c6ff9dfaebf193db3b1b62",
"blood": 3,
"city": "Донецк",
"email": "[email protected]",
"firstName": "Данилов",
"image": "http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328374/g0dbepurojsqvgulifnl.png",
"lastName": "Владимирович",
"phone": "+380669181748",
"ready": false,
"rhesus": "+",
"secondName": "Андрей"
}]
### Создание пользователя [POST]
+ Request (application/json)
{
"firstName": "Иванов",
"secondName": "Иван",
"lastName":"Иванович",
"city": "Днепропетровск",
"phone":"+380661234567",
"email":"[email protected]",
"blood":3,
"rhesus":"+",
"ready":true,
"image":"http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328374/g0dbepurojsqvgulifnl.png",
"password":"*******"
}
+ Response 200 (application/json)
{
"__v": 0,
"firstName": "Иванов",
"secondName": "Иван",
"lastName": "Иванович",
"city": "Днепропетровск",
"phone": "+380661234567",
"email": "[email protected]",
"blood": 3,
"rhesus": "+",
"ready": true,
"image":"http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328374/g0dbepurojsqvgulifnl.png",
"_id": "54be9f25d86a515e79dfb8fa"
}
## User [/users/{id}]
Объект пользователя и его параметры
### Получение пользователя [GET]
+ Response 200 (application/json)
+ Header
X-My-Header: The Value
+ Body
{
"__v": 0,
"_id": "54c6ffb8faebf193db3b1b63",
"blood": 1,
"city": "Днепропетровск",
"email": "[email protected]",
"firstName": "Герасименко",
"image": "http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328297/jcmz3aye1xun1690o9kh.jpg",
"lastName": "Вячеславович",
"phone": "+380669181748",
"ready": false,
"rhesus": "+",
"secondName": "Роман"
}
### Редактирование пользователя [PUT]
+ Request (application/json)
{
"blood": 1,
"city": "Днепропетровск",
"email": "[email protected]",
"firstName": "Герасименко",
"image": "http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328297/jcmz3aye1xun1690o9kh.jpg",
"lastName": "Вячеславович",
"phone": "+380669181748",
"ready": false,
"rhesus": "+",
"secondName": "Роман"
}
+ Response 200 (application/json)
{
"__v": 0,
"_id": "54c6ffb8faebf193db3b1b63",
"blood": 1,
"city": "Днепропетровск",
"email": "[email protected]",
"firstName": "Герасименко",
"image": "http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328297/jcmz3aye1xun1690o9kh.jpg",
"lastName": "Вячеславович",
"phone": "+380669181748",
"ready": false,
"rhesus": "+",
"secondName": "Роман"
}
# Group Authentication
## Авторизация [/auth/]
Проверка логина/пароля пользователя и выдача для пользования токена.
Система токенов - вечная (кроме случая принудительного logourt)
### Получение токена для работы с АПИ [POST]
+ Request (www-form-urlencoded)
login: [email protected]
password: [email protected]
+ Response 200 (application/json)
+ Header
Token: token value
+ Body
{
"firstName": "Герасименко",
"secondName": "Роман",
"lastName": "Вячеславович",
"city": "Днепропетровск",
"phone": "+380669181748",
"email": "[email protected]",
"blood": 3,
"rhesus": "+",
"ready": false,
"password": "$2a$08$1LiY54m1859Zvk9yabHXDOSmpmB4MRR3WHqPuZhkB2TX1Iu8pTNfy",
"_id": "54dc08f32ef4d89894b553d3",
"__v": 0
}
# Group Friends
Получение списка друзей, отправка запроса на добавление в друзья
## Friend [/friends/{id}]
Работа со списками друзей пользователя
Статусы:
**accepted** - оба друг у друга в друзьях
**requested** - это значит что ты человеку кинул запрос на дружбу
**pending** - это значит что тебе кинули запрос на дружбу
### Получение списка друзей пользователя [GET]
+ Parameters
+ id (required, string, `54be9f25d86a515e79dfb8fa`) ... Идентификатор `_id` пользователя (текущий или любой другой, если ты хочешь просмотреть его френдов)
+ Response 200 (application/json)
+ Header
X-My-Header: The Value
+ Body
[
{
"_id": "54c6ffb8faebf193db3b1b63",
"added": "2015-01-27T03:04:05.603Z",
"status": "accepted",
"friend": {
"__v": 0,
"_id": "54c6ffb8faebf193db3b1b63",
"blood": 1,
"city": "Днепропетровск",
"email": "[email protected]",
"firstName": "Герасименко",
"image": "http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328297/jcmz3aye1xun1690o9kh.jpg",
"lastName": "Вячеславович",
"phone": "+380669181748",
"ready": false,
"rhesus": "+",
"secondName": "Роман"
}
}
]
## Friendsip [/friends/{id1}/{id2}]
Запрос на добавление пользователя во френды
Для подтверждения дружбы необходимо отправить запрос поменяв местами id1 и id2 - это служит подтверждением
### Отправка запроса на дружбу пользователем [GET]
+ Parameters
+ id1 (required, string, `54be9f25d86a515e79dfb8fa`) ... Идентификатор `_id` пользователя (текущий)
+ id2 (required, string, `54be9f25d86a515e79dfb8fa`) ... Идентификатор `_id` пользователя (которого хочешь добавить в друзья)
+ Response 200 (application/json)
+ Header
X-My-Header: The Value
+ Body
[
{
"_id": "54c6ffb8faebf193db3b1b63",
"status": "pending",
"added": "2015-01-27T03:04:05.603Z",
"friend": {
"__v": 0,
"_id": "54c6ffb8faebf193db3b1b63",
"blood": 1,
"city": "Днепропетровск",
"email": "[email protected]",
"firstName": "Герасименко",
"lastName": "Вячеславович",
"phone": "+380669181748",
"ready": false,
"rhesus": "+",
"secondName": "Роман"
}
}
]
# Group Articles
Работа со статьяими, и справочной информацией для пользователя
## Articles Collection [/articles]
### Получение списка статей[GET]
+ Response 200 (application/json)
[{
"title": "Пам'ятка донора крові",
"snippet": "Вирішивши стати донором, людина робить відповідальний вибір. Ще вчора він відповідав тільки за стан свого здоров'я, а сьогодні - вже і за самопочуття інших людей. Відтепер у його житті з'явився особливий, невідомий раніше сенс - дарувати здоров'я ти",
"content": "Вирішивши стати донором, людина робить відповідальний вибір. Ще вчора він відповідав тільки за стан свого здоров'я, а сьогодні - вже і за самопочуття інших людей. Відтепер у його житті з'явився особливий, невідомий раніше сенс - дарувати здоров'я тим, хто потрапив в біду, і знаходити тим самим «кровних хрещеників» - братів, сестер, дітей. Донор несе надію і здоров'я десяткам людей. Тому він не може ризикувати собою заради сумнівних задоволень. Тому, якщо Ви вирішили стати донором, Вам необхідно навчитися берегти себе заради інших. Здоровий спосіб життя донора передбачає правильне харчування і прийом вітамінів, відмова від надмірного вживання алкоголю, бажано - і куріння, дотримання інтервалів між дачами крові. Важливо, щоб `донорство не заподіяло шкоди ні донору, ні реципієнту. Якщо з якихось причин лікар сьогодні не допускає Вас до дачі крові, необхідно прислухатися до його рекомендацій. Краще один раз утриматися від дачі крові, ніж потім бути вимушеним назавжди відмовитися від донорства. Якщо Вас щось турбує, обов'язково порадьтеся з лікарем на Станції переливання крові. При дотриманні простих правил `донорство буде корисним для Вашого здоров'я і може на довгі роки стать стилем життя. Адже якщо Ви - донор, означає, Ви здорові.",
"_id": "54bec0d6bc7a3529a75b13d6",
"__v": 0
}]
### Добавление статьи - только для админ панели [POST]
+ Request (application/json)
{
"title": "Заголовок",
"snippet": "Краткое описание статьи",
"content":"Полный текст статьи"
}
+ Response 200 (application/json)
{
"title": "Заголовок",
"snippet": "Краткое описание статьи",
"content":"Полный текст статьи",
"_id": "54bec0d6bc7a3529a75b13d6",
"__v": 0
}
# Group Posts
Работа с постами пользователей, объявлениями
## Posts Collection [/posts]
### Получение списка постов [GET]
+ Response 200 (application/json)
[{
"__v": 0,
"title": "Требуется кровь 4+",
"description": "В больницу Мечникова, воинам АТО",
"city": "В больницу Мечникова, воинам АТО",
"dueDate": "21.02.15",
"_id": "54caccc38e6c70c21ec357b4",
"views": 0,
"pinned": false, // Закреплено
"moderated": false, // Отмодерированно и допущено к показу
"created": "2015-01-30T00:13:55.281Z",
"creator": [
{
"__v": 0,
"_id": "54c8043a6e4c610c00d26f62",
"ready": false,
"rhesus": "+",
"blood": 4,
"email": "[email protected]",
"secondName": "банка",
"firstName": "аппарат",
"friends": []
}
]
}]
## Post [/posts/{id}]
+ Parameters
+ id (required, string, `54c8043a6e4c610c00d26f62`) ... Идентификатор пользователя (потом заменю на токен)
### Запрос на создание нового поста [POST]
+ Request (application/json)
{
"title": "Заголовок поста",
"description": "Описание поста",
"city":"Город",
"dueDate": "21.02.15"
}
+ Response 200 (application/json)
{
"__v": 0,
"title": "Требуется кровь 4+",
"description": "В больницу Мечникова, воинам АТО",
"city": "В больницу Мечникова, воинам АТО",
"dueDate": "21.02.15",
"_id": "54caccc38e6c70c21ec357b4",
"views": 0,
"pinned": false, // Закреплено
"moderated": false, // Отмодерированно и допущено к показу
"created": "2015-01-30T00:13:55.281Z",
"creator": [
{
"__v": 0,
"_id": "54c8043a6e4c610c00d26f62",
"ready": false,
"rhesus": "+",
"blood": 4,
"email": "[email protected]",
"secondName": "банка",
"firstName": "аппарат",
"friends": []
}
]
}
# Group SMS
Работа с СМС авторизацией (otp - one -time-password)
## Otp [/otp/{phone}]
Объект смс авторизации и его параметры
+ Parameters
+ phone (required, string, `380669181948`) ... Номер телефона `phone` клиента, без '+'
### Запрос на отправку СМС пользователю [GET]
+ Response 200 (application/json)
+ Body
SMS Was sent
## Otp [/otp/{id}/{code}]
+ Parameters
+ id (required, string, `54be9f25d86a515e79dfb8fa`) ... Идентификатор `_id` из запроса на отправку СМС
+ code (required, string, `28045087`) ... Код из смс, полученный пользователем
### Проверка полученного пользователем кода [GET]
+ Response 200 (application/json)
+ Body
{
"phone":"380669181748",
"operation_id":153608,"
_id":"54bed4688846f446c851bd06",
"__v":0
}
# Group City
Работа со справочником городов
## Cities collection [/city]
### Получение списка городов [GET]
+ Response 200 (application/json)
[
{
"city": "Днепропетровск",
"zip": 49000,
"_id": "54eb8e398f2854675a525405",
"__v": 0
},
{
"city": "Киев",
"zip": 1001,
"_id": "54eb8e4b8f2854675a525406",
"__v": 0
}
]
# Group Images
Работа с аватарками пользователя
## Images Collection [/images/{id}]
### Получение списка изображений из БД - будет только для админки[GET]
+ Response 200 (application/json)
[{
"url":"http://res.cloudinary.com/hhfgxm0qi/image/upload/v1421969248/fox5nbs7gfrv56xoykrd.jpg",
"secureUrl":"https://res.cloudinary.com/hhfgxm0qi/image/upload/v1421969248/fox5nbs7gfrv56xoykrd.jpg",
"format":"jpg",
"created":"2015-01-22T23:27:28Z",
"width":1024,
"height":500,
"_id":"54c1876022e686e015f9bff2",
"__v":0
}]
### Заливка изображения в БД [POST]
Делаешь через:
**@Multipart**
**@Post(UPLOAD_IMAGE_URL)**
**Image uploadPhoto(@Part("image") TypedFile image);**
+ Request (application/json)
+ Parameters
+ id (required, string, `54be9f25d86a515e79dfb8fa`) ... Идентификатор `_id` пользователя, которому будет присвоено изображение
+ Response 200 (application/json)
{
"__v": 0,
"_id": "54c6ffb8faebf193db3b1b63",
"blood": 1,
"city": "Днепропетровск",
"email": "[email protected]",
"firstName": "Герасименко",
"image": "http://res.cloudinary.com/hhfgxm0qi/image/upload/v1422328297/jcmz3aye1xun1690o9kh.jpg",
"lastName": "Вячеславович",
"phone": "+380669181748",
"ready": false,
"rhesus": "+",
"secondName": "Роман"
}