-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.html
910 lines (839 loc) · 24.4 KB
/
readme.html
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Руководство программиста</title>
<style>
body {
background-color: rgb(219, 219, 219);
font-family: Arial, Helvetica, sans-serif;
font-size: 18px;
}
a:visited {
color: blue;
}
.container {
background-color: #fff;
max-width: 1920px;
margin: 0 auto;
padding: 15px;
}
.main-desc {
font-size: 20px;
border-bottom: 1px solid #000;
padding-bottom: 10px;
}
.block {
margin-bottom: 40px;
}
.block__title {
font-size: 40px;
text-transform: uppercase;
margin-bottom: 10px;
}
.method {
font-weight: 600;
border-radius: 10px;
text-align: center;
width: fit-content;
padding: 5px;
}
.method-post {
background-color: rgb(255, 208, 0);
}
.method-get {
background-color: rgb(100, 136, 255);
}
.url {
font-size: 18px;
color: rgb(100, 100, 100);
}
.param-type {
font-size: 15px;
font-style: italic;
color: rgb(100, 100, 100);
}
.status-code {
color: #fff;
padding: 0px 3px;
}
.code-200 {
background-color: rgb(7, 160, 45);
}
table {
width: 100%;
}
.query-param {
color: rgb(0, 38, 255);
}
table {
border-collapse: collapse;
}
table td {
border: 1px solid rgb(214, 214, 214);
text-align: left;
vertical-align: top;
padding: 10px;
}
.entity {
margin-bottom: 40px;
}
.entity__name {
font-size: 25px;
font-weight: 800;
}
.block table th:nth-child(1),
.block table td:nth-child(1) {
width: 5%;
}
.block table th:nth-child(2),
.block table td:nth-child(2) {
width: 25%;
}
.block table th:nth-child(3),
.block table td:nth-child(3) {
width: 15%;
}
.block table th:nth-child(4),
.block table td:nth-child(4) {
width: 15%;
}
.entity table th:nth-child(1),
.entity table td:nth-child(1) {
width: 30%;
}
.entity table th:nth-child(2),
.entity table td:nth-child(2) {
width: 20%;
}
.entity table th:nth-child(3),
.entity table td:nth-child(3) {
width: 50%;
}
.example {
display: flex;
justify-content: space-between;
margin-bottom: 20px;
}
.example-body:nth-child(2) {
background-color: rgb(236, 239, 241);
}
.example-body:nth-child(3) {
background-color: rgb(237, 241, 236);
}
.example-body:nth-child(4) {
background-color: rgb(240, 236, 241);
}
.example-body:nth-child(5) {
background-color: rgb(241, 239, 236);
}
.example__number {
font-size: 22px;
margin-bottom: 5px;
}
.example__title {
text-align: center;
font-weight: 800;
}
.query {
text-align: left;
width: 40%;
}
.response {
width: 40%;
}
pre {
margin: 0;
}
</style>
</head>
<body>
<div class="container">
<p class="main-desc">Данное руководство представляет из себя описание всех доступных методов API, типов данных и
др. Примеры находятся <a href="#example">внизу</a> страницы</p>
<div class="methods" id="methods">
<div class="block">
<div class="block__title">Логирование и регистрация</div>
<table>
<tr>
<th>Метод</th>
<th>URL</th>
<th>Название</th>
<th>Параметры</th>
<th>Описание</th>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/auth/signin</td>
<td class="title">Вход</td>
<td class="params">
<ul>
<li>Username <span class="param-type">string</span></li>
<li>Password <span class="param-type">string</span></li>
</ul>
</td>
<td class="description">
Авторизует пользователя в системе.<br>
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/auth/signout</td>
<td class="title">Выход</td>
<td class="params"></td>
<td class="description">Выходит из системы</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/auth/create</td>
<td class="title">Регистрация</td>
<td class="params">
<ul>
<li>Username <span class="param-type">string</span></li>
<li>Password <span class="param-type">string</span></li>
</ul>
</td>
<td class="description">Регистрирует нового пользователя и авторизует его.<br>
Username - длина от 6 до 32<br>
Password - длина от 6 до 16<br>
</tr>
</table>
</div>
<div class="block">
<div class="block__title">Пользователи</div>
<table>
<tr>
<th>Метод</th>
<th>URL</th>
<th>Название</th>
<th>Параметры</th>
<th>Описание</th>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/users/<span class="query-param">{id}</span></td>
<td class="title">О пользователе</td>
<td class="params"></td>
<td class="description">
Получить информацию о пользователе<br>
по <span class="query-param">id</span> - идентификатору пользователя.<br>
Возвращает один объект типа <a href="#user">User</a>
</td>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/users/me</td>
<td class="title">О себе</td>
<td class="params"></td>
<td class="description">
Получить информацию о пользователе (о себе)<br>
Возвращает один объект типа <a href="#user">User</a>
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/users/edit</td>
<td class="title">Редактирование</td>
<td class="params">
Объект типа <a href="#user">User</a>
</td>
<td class="description">
Изменить данные пользователя<br>
Возвращает объект типа <a href="#user">User</a> с изменениями<br>
</td>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/users/<span class="query-param">{id}</span>/friends</td>
<td class="title">Список друзей</td>
<td class="params"></td>
<td class="description">
Получить список друзей пользователя<br>
по <span class="query-param">id</span> - идентификатору пользователя.<br>
Возвращает массив объектов с полями:<br>
Id - идентификатор дружбы<br>
FriendId - идентификатор пользователя друга
</td>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/users/<span class="query-param">{id}</span>/followers</td>
<td class="title">Список подписчиков</td>
<td class="params"></td>
<td class="description">
Получить список подписчиков пользователя<br>
по <span class="query-param">id</span> - идентификатору пользователя.<br>
Возвращает массив объектов с полями:<br>
Id - идентификатор подписки<br>
FollowerId - идентификатор подписчика
</td>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/users/<span class="query-param">{id}</span>/requests</td>
<td class="title">Список запросов</td>
<td class="params"></td>
<td class="description">
Получить список запросов пользователя<br>
по <span class="query-param">id</span> - идентификатору пользователя.<br>
Возвращает массив объектов с полями:<br>
Id - идентификатор запроса<br>
RequestId - идентификатор подписки
</td>
</tr>
</table>
</div>
<div class="block">
<div class="block__title">Друзья, подписки и подписчики</div>
<table>
<tr>
<th>Метод</th>
<th>URL</th>
<th>Название</th>
<th>Параметры</th>
<th>Описание</th>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/friends/add/<span class="query-param">{id}</span></td>
<td class="title">Добавить в друзья</td>
<td class="params">
</td>
<td class="description">
Добавляет в друзья (либо подписывается)<br>
на пользователя по <span class="query-param">id</span> пользователя <br>
Возвращает объект с полями: <br>
Message - сообщение о проделаной операции <br>
Id - в зависимости от Message либо идентификатор дружбы, <br>
либо идентификатор запроса в друзья
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/friends/<span class="query-param">{friendshipId}</span>/remove</td>
<td class="title">Удалить из друзей</td>
<td class="params"></td>
<td class="description">
Удаляет из друзей по <span class="query-param">friendshipId</span> -- <br>
идентификатор дружбы (не пользователя)
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/friends/unfollow/<span class="query-param">{id}</span></td>
<td class="title">Отписаться</td>
<td class="params">
</td>
<td class="description">
Отписывает от пользователя (отменят запрос в друзья)<br>
по <span class="query-param">id</span> - идентификатору пользователя<br>
</tr>
</table>
</div>
<div class="block">
<div class="block__title">Диалоги</div>
<table>
<tr>
<th>Метод</th>
<th>URL</th>
<th>Название</th>
<th>Параметры</th>
<th>Описание</th>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/dialogs</td>
<td class="title">Список диалогов</td>
<td class="params">
</td>
<td class="description">
Получить список диалогов пользователя.<br>
Возвращает массив объектов типа <a href="#dialog">Dialog</a><br>
</td>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/dialogs/<span class="query-param">{id}</span>/messages</td>
<td class="title">Список сообщений диалога</td>
<td class="params"></td>
<td class="description">
Получить список сообщений из диалога с идентификатором <span class="query-param">id</span>.<br>
Возвращает массив объектов <a href="#message">Message</a>
</td>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/dialogs/<span class="query-param">{id}</span>/members</td>
<td class="title">Список участников</td>
<td class="params">
</td>
<td class="description">
Получить список участников диалога<br>
по <span class="query-param">id</span> - идентификатору диалога.<br>
Возвращает массив индентификаторов пользователей-участников.
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/dialogs/<span class="query-param">{id}</span>/message</td>
<td class="title">Написать сообщение</td>
<td class="params">
<ul>
<li>Text <span class="param-type">string</span></li>
</ul>
</td>
<td class="description">
Добавляет новое сообщение в диалог по <span class="query-param">id</span> диалога.<br>
Теxt - длина до 10000 <br>
Возвращает объект типа <a href="#message">Message</a>
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/dialogs/create</td>
<td class="title">Создать диалог</td>
<td class="params">
<ul>
<li>Title <span class="param-type">string</span></li>
</ul>
</td>
<td class="description">
Создает новый диалог с названием Title.<br>
Title - длина от 1 до 32<br>
Возвращает объект типа <a href="#dialog">Dialog</a>
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/dialogs/<span class="query-param">{id}</span>/add</td>
<td class="title">Добавить пользователей</td>
<td class="params">
<ul>
<li>UserIds <span class="param-type">массив int</span></li>
</ul>
</td>
<td class="description">
Добавляет пользователей в диалог по <span class="query-param">id</span> диалога.<br>
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/dialogs/<span class="query-param">{id}</span>/leave</td>
<td class="title">Выйти из диалога</td>
<td class="params">
</td>
<td class="description">
Позволяет пользователю выйти из диалога<br>
по <span class="query-param">id</span> диалога.
</td>
</tr>
</table>
</div>
<div class="block">
<div class="block__title">Сообщения</div>
<table>
<tr>
<th>Метод</th>
<th>URL</th>
<th>Название</th>
<th>Параметры</th>
<th>Описание</th>
</tr>
<tr>
<td>
<div class="method method-get">GET</div>
</td>
<td class="url">/api/messages/<span class="query-param">{id}</span></td>
<td class="title">Инфо о сообщении</td>
<td class="params">
</td>
<td class="description">
Получить одно сообщение по <span class="query-param">id</span> сообщения.<br>
Возвращает объект типа <a href="#message">Message</a><br>
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/messages/<span class="query-param">{id}</span>/edit</td>
<td class="title">Редактирование</td>
<td class="params">
<ul>
<li>Объект типа <a href="#message">Message</a></li>
</ul>
</td>
<td class="description">
Редактирует сообщение по <span class="query-param">id</span> сообщения.<br>
Возвращает объект типа <a href="#message">Message</a>
</td>
</tr>
<tr>
<td>
<div class="method method-post">POST</div>
</td>
<td class="url">/api/messages/<span class="query-param">{id}</span>/delete</td>
<td class="title">Удалить</td>
<td class="params">
</td>
<td class="description">
Удаляет сообщение пользователя<br>
по <span class="query-param">id</span> - идентификатору сообщения.<br>
</tr>
</table>
</div>
</div>
<div class="block">
<div class="block__title">Типы данных</div>
<div class="entity">
<div id="user" class="entity__name">User (пользователь)</div>
<div class="entity__fields">
<table>
<tr>
<th>Название</th>
<th>Тип данных</th>
<th>Описание</th>
</tr>
<tr>
<td>Id</td>
<td><span class="param-type">int</span></td>
<td>Уникальный идентификатор</td>
</tr>
<tr>
<td>UserName</td>
<td><span class="param-type">string</span></td>
<td>Логин</td>
</tr>
<tr>
<td>Email</td>
<td><span class="param-type">string</span></td>
<td>Адрес электронной почты</td>
</tr>
<tr>
<td>BirthdayDate</td>
<td><span class="param-type">string</span></td>
<td>Дата рождения</td>
</tr>
<tr>
<td>Sex</td>
<td><span class="param-type">int</span></td>
<td>Пол
<ul>
<li>0 - Мужской</li>
<li>1 - Женский</li>
<li>2 - Другой</li>
</ul>
</td>
</tr>
<tr>
<td>Status</td>
<td><span class="param-type">string</span></td>
<td>Статус</td>
</tr>
</table>
</div>
</div>
<div class="entity">
<div id="dialog" class="entity__name">Dialog (диалог)</div>
<div class="entity__fields">
<table>
<tr>
<th>Название</th>
<th>Тип данных</th>
<th>Описание</th>
</tr>
<tr>
<td>Id</td>
<td><span class="param-type">int</span></td>
<td>Уникальный идентификатор</td>
</tr>
<tr>
<td>Title</td>
<td><span class="param-type">string</span></td>
<td>Название</td>
</tr>
<tr>
<td>CreatingTime</td>
<td><span class="param-type">DateTime</span></td>
<td>Дата создания диалога</td>
</tr>
<tr>
<td>LastMessageTime</td>
<td><span class="param-type">DateTime</span></td>
<td>Дата последнего сообщения</td>
</tr>
</table>
</div>
</div>
<div class="entity">
<div id="message" class="entity__name">Message (сообщение)</div>
<div class="entity__fields">
<table>
<tr>
<th>Название</th>
<th>Тип данных</th>
<th>Описание</th>
</tr>
<tr>
<td>Id</td>
<td><span class="param-type">int</span></td>
<td>Уникальный идентификатор</td>
</tr>
<tr>
<td>Text</td>
<td><span class="param-type">string</span></td>
<td>Текст сообщения</td>
</tr>
<tr>
<td>SendingTime</td>
<td><span class="param-type">DateTime</span></td>
<td>Время отправки</td>
</tr>
<tr>
<td>AuthorId</td>
<td><span class="param-type">int</span></td>
<td>Уникальный идентификатор автора сообщения</td>
</tr>
</table>
</div>
</div>
<div class="entity">
<div id="response" class="entity__name">Reponse (ответ от сервера)</div>
<div class="entity__fields">
<table>
<tr>
<th>Название</th>
<th>Тип данных</th>
<th>Описание</th>
</tr>
<tr>
<td>Ok</td>
<td><span class="param-type">bool</span></td>
<td>Если <strong>true</strong> - успешное выполнение,<br>
если <strong>false</strong> - ошибка при выполнении
</td>
</tr>
<tr>
<td>StatusCode</td>
<td><span class="param-type">int</span></td>
<td>Статусный код ответа</td>
</tr>
<tr>
<td>Description</td>
<td><span class="param-type">string</span></td>
<td>Человекочитаемое описание причины ошибки</td>
</tr>
<tr>
<td>Result</td>
<td><span class="param-type">Любой</span></td>
<td>Возвращаемый результат, если таковой ожидается <br>
(<a href="#methods">см.</a> какой метод, что возвращает)
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="block">
<div id="example" class="block__title">Примеры</div>
<div class="example-body">
<div class="example__number">1) Логирование (успешное)</div>
<div class="example">
<div class="query">
<div class="example__title">Запрос</div>
<pre>
<code>
$.ajax({
url: '/api/auth/signin',
type: 'POST',
contentType: 'application/json; charset=utf-8',
data: JSON.stringify({
username: 'User',
password: '123456'
}),
dataType: 'json',
success: function(result) {
console.log(result);
}
});
</code>
</pre>
</div>
<div class="response">
<div class="example__title">Ответ</div>
<pre>
<code>
{
"ok": true,
"statusCode": 200,
"description": null,
"result": null
}
</code>
</pre>
</div>
</div>
</div>
<div class="example-body">
<div class="example__number">2) Получение списка друзей</div>
<div class="example">
<div class="query">
<div class="example__title">Запрос</div>
<pre>
<code>
$.ajax({
url: '/api/users/1/friends',
type: 'GET',
dataType: 'json',
success: function(result) {
console.log(result);
}
});
</code>
</pre>
</div>
<div class="response">
<div class="example__title">Ответ</div>
<pre>
<code>
{
"ok": true,
"statusCode": 200,
"description": null,
"result": [
{
"id": 3,
"friendId": 3
},
{
"id": 4,
"friendId": 2
}
]
}
</code>
</pre>
</div>
</div>
</div>
<div class="example-body">
<div class="example__number">3) Получение информации о сообщении (неудача)</div>
<div class="example">
<div class="query">
<div class="example__title">Запрос</div>
<pre>
<code>
$.ajax({
url: '/api/messages/1000',
type: 'GET',
dataType: 'json',
success: function(result) {
console.log(result);
}
});
</code>
</pre>
</div>
<div class="response">
<div class="example__title">Ответ</div>
<pre>
<code>
{
"ok": false,
"statusCode": 404,
"description": "Сообщение не найдено",
"result": null
}
</code>
</pre>
</div>
</div>
</div>
<div class="example-body">
<div class="example__number">4) Редактирование пользователя (передача и получение сложного объекта)</div>
<div class="example">
<div class="query">
<div class="example__title">Запрос</div>
<pre>
<code>
$.ajax({
url: '/api/users/edit',
type: 'POST',
contentType: 'application/json; charset=utf-8',
data: JSON.stringify({
username: 'Ivan',
status: 'У меня новый статус!',
sex: 0
}),
dataType: 'json',
success: function(result) {
console.log(result);
}
});
</code>
</pre>
</div>
<div class="response">
<div class="example__title">Ответ</div>
<pre>
<code>
{
"ok": true,
"statusCode": 200,
"description": null,
"result": {
"id": 2,
"userName": "Ivan",
"email": null,
"birthdayDate": null,
"sex": 0,
"status": "У меня новый статус!"
}
}
</code>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>