-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAPI.yaml
1080 lines (1075 loc) · 28.7 KB
/
API.yaml
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
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: "2.0"
info:
description: This is a simple API
version: 1.0.0
title: LiDi API Collections
# put the contact info for your development or API team
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
# tags are used for organizing operations
tags:
- name: admin
description: Quản trị viên hệ thống, người nắm quyền cao nhất
- name: smod
description: Quản trị viên hệ thống, giám sát mod
- name: mod
description: Quản trị viên hệ thống, giám sát user
- name: user
description: Khách, học viên, giảng viên truy cập website chính
paths:
/common/api/auth/signin:
post:
tags:
- user
- admin
- smod
- mod
description: signin
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: loginItem
schema:
type: object
required:
- email
- password
properties:
email:
type: string
password:
type: string
example: {
"email": "vinhtt95@gmailcom",
"password": "123456"
}
responses:
200:
description: authen successful
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
properties:
jwtToken:
type: string
username:
type: string
role:
type: array
items:
$ref: '#/definitions/Role'
example: {
"code": 200,
"message": "Successful",
"data": {
"jwtToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ2aW5odHQ5NUBnbWFpbC5jb20iLCJpYXQiOjE2MDAwNjI4ODAsImV4cCI6MTYwMDE0OTI4MH0.s6eA5ydKGCQorkZE3zH6Itb_JSyGrJgk39ubyEFpXNttL1J63I0RKgh0TZ4XEefq_Q4BHsDh20xbwezUY2QCWQ",
"email": "[email protected]",
"roles": [
"ROLE_STUDENT"
]
}
}
401:
$ref: '#/definitions/Response/401'
405:
$ref: '#/definitions/Response/405'
406:
$ref: '#/definitions/Response/406'
/common/api/auth/signup:
post:
tags:
- user
description: signup
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: signupItem
description: Thông tin đăng ký tài khoản
schema:
type: object
required:
- email
- password
- dob
- fullName
- phoneNumber
- gender
properties:
email:
type: string
password:
type: string
dob:
type: string
format: dd/MM/yyyy
fullName:
type: string
phoneNumber:
type: string
format: (0)+([0-9]{9})
gender:
type: string
format: male|female|other
example: {
"email": "[email protected]",
"password": "123456",
"dob": "03/02/1998",
"fullName": "Lê Sơn Tùng",
"phoneNumber": "0342529988",
"gender": "male",
"roles": [
"ROLE_STUDENT","ROLE_TEACHER"
]
}
responses:
200:
description: signup successful
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
properties:
jwtToken:
type: string
username:
type: string
role:
type: array
items:
$ref: '#/definitions/Role'
example: {
"code": 200,
"message": "Successful",
"data": {
"jwtToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0dW5nbHNzZTA1NzAzQGZwdC5lZHUudm4iLCJpYXQiOjE2MDAwNjQ5NjEsImV4cCI6MTYwMDE1MTM2MX0.6dgmQ61I6IbAdKmaKCnr3UdRNfgvyKpXzYHJhDP8IcSdrZePX7fp8u2DjqJq8GpQZEnya1IM6Hszs6vRFHhV_w",
"email": "[email protected]",
"roles": [
"ROLE_STUDENT","ROLE_TEACHER"
]
}
}
405: empty parameter
$ref: '#/definitions/Response/405'
406: undefined exception
$ref: '#/definitions/Response/406'
407:
$ref: '#/definiions/Response/407'
408:
$ref: '#/definitions/Response/408'
/common/api/auth/change-password:
post:
tags:
- user
description: Thay đổi mật khẩu mới
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: inventoryItem
schema:
type: object
required:
- email
- oldPassword
- newPassword
properties:
email:
type: string
oldPassword:
type: string
newPassword:
type: string
example: {
"email": "[email protected]",
"oldPassword": "123445",
"newPassword": "123@123a"
}
responses:
200:
description: OK
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
properties:
jwtToken:
type: string
username:
type: string
role:
type: array
items:
$ref: '#/definitions/Role'
example: {
"code": 200,
"message": "Update password successful!",
"data": {
"jwtToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0dW5nbHNzZTA1NzAzQGZwdC5lZHUudm4iLCJpYXQiOjE2MDAwNjQ5NjEsImV4cCI6MTYwMDE1MTM2MX0.6dgmQ61I6IbAdKmaKCnr3UdRNfgvyKpXzYHJhDP8IcSdrZePX7fp8u2DjqJq8GpQZEnya1IM6Hszs6vRFHhV_w",
"email": "[email protected]",
"roles": [
"ROLE_STUDENT"
]
}
}
400:
description: Authentiaction failed
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 401,
"message": "Change password failed!",
"data": null
}
400:
description: Parameter invalid, empty, null
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 405,
"message": "Parameter invalid!",
"data": null
}
400:
description: Old password is incorrect
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 405,
"message": "Old password is incorrect!",
"data": null
}
/common/api/auth/get-verify-code:
get:
tags:
- user
description: Lấy code để đặt mật khẩu mới
consumes:
- application/json
produces:
- application/json
parameters:
name: email
type: string
example: [email protected]
responses:
200:
description: email sent
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 200,
"message": "Email sent!",
"data": null
}
400:
description: Send code failed!
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 401,
"message": "Send code failed!",
"data": null
}
/common/api/auth/verify-code:
post:
tags:
- user
description: verify code để reset password
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: inventoryItem
schema:
type: object
required:
- email
- verifyCode
properties:
email:
type: string
verifyCode:
type: string
responses:
200:
description: Verify successful
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
properties:
resetCode:
type: string
example: {
"code": 200,
"message": "Verify successful!",
"data": {
"resetCode": "$2a$10$V406uU5yjfi6Comjqfi9AeLcAzqwY7eeoYWZ8cSZYqDHl0mZmPd.O"
}
}
400:
description: Send code failed!
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 401,
"message": "Send code failed!",
"data": null
}
400:
description: Parameter invalid, empty, null
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 405,
"message": "Parameter invalid!",
"data": null
}
400:
description: wrong verify code
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 405,
"message": "Verified code is invalid!",
"data": null
}
400:
description: verify code is expired
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 405,
"message": "Verified code is expired!",
"data": null
}
/common/api/auth/reset-password:
post:
tags:
- user
description: Đổi mật khẩu mới từ link gửi trong mail
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: inventoryItem
schema:
type: object
required:
- email
- newPassword
- resetCode
properties:
email:
type: string
newPassword:
type: string
resetCode:
type: string
example: {
"email": "[email protected]",
"resetCode": "$2a$10$GnlAFNgwt8BDSb8tE.Ih1..9z4yMy5ARnsULan9mskFzvPp9NXWcO",
"newPassword": "123456"
}
responses:
200:
description: OK
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
properties:
jwtToken:
type: string
username:
type: string
role:
type: array
items:
$ref: '#/definitions/Role'
example: {
"code": 200,
"message": "Reset password successfull!",
"data": {
"jwtToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJzb250dW5nMTk5eEBnbWFpbC5jb20iLCJpYXQiOjE2MDAwNzAwMTMsImV4cCI6MTYwMDE1NjQxM30.3-sSZIfkbaBQdc50CGJGCZ09cAjHTulKnkkzYcCNifSJ2nDgSoezp6yYTJ0wqdLlgmoYjuRM-loYRWUpL0WeSg",
"email": "[email protected]",
"roles": [
"ROLE_STUDENT"
]
}
}
400:
description: Reset password failed
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 401,
"message": "Reset password failed!",
"data": null
}
400:
description: Parameter invalid, empty, null
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 405,
"message": "Parameter invalid!",
"data": null
}
400:
description: invalid reset code
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 405,
"message": "Reset code is invalid!",
"data": null
}
/products:
get:
tags:
- user
- mod
- smod
- admin
summary: Danh sách các khoá học
operationId: listProducts
description: Liệt kê các khoá học
produces:
- applications/json
parameters:
- in: query
name: searchString
description: pass an optional search string for looking up inventory
required: false
type: string
- in: query
name: skip
description: number of records to skip for pagination
type: integer
format: int32
minimum: 0
- in: query
name: limit
description: maximum number of records to return
type: integer
format: int32
minimum: 0
maximum: 50
responses:
200:
description: search results matching criteria
schema:
type: array
items:
$ref: '#/definitions/ProductsItem'
400:
description: bad input parameter
post:
tags:
- admin
summary: adds an inventory item
operationId: addInventory
description: Adds an item to the system
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: inventoryItem
description: Inventory item to add
schema:
$ref: '#/definitions/ProductsItem'
responses:
201:
description: item created
400:
description: invalid input, object invalid
409:
description: an existing item already exists
/users:
get:
tags:
- user
- mod
- smod
- admin
summary: Danh sách các thành viên
operationId: members
description: |
Liệt kê tất cả các tài khoản
produces:
- application/json
parameters:
- in: query
name: id
description: lấy thông tin của một tài khoản cụ thể theo ID
type: integer
format: int32
minimum: 0
- in: query
name: skip
description: number of records to skip for pagination
type: integer
format: int32
minimum: 0
- in: query
name: limit
description: maximum number of records to return
type: integer
format: int32
minimum: 0
maximum: 50
responses:
200:
description: search results matching criteria
schema:
type: array
items:
$ref: '#/definitions/Users'
400:
description: bad input parameter
put:
tags:
- user
- mod
- smod
- admin
summary: Chỉnh sửa thông tin tài khoản
operationId: updateUser
description: Chỉnh sửa thông tin tài khoản
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: inventoryItem
description: Đưa toàn bộ thông tin của 1 tài khoản
schema:
$ref: '#/definitions/Users'
responses:
201:
description: update done
400:
description: invalid input, object invalid
409:
description: an existing item already exists
/cart:
get:
tags:
- user
summary: danh sach cac san pham trong gio hang
operationId: listCart
description: |
Liệt kê tất cả các sản phẩm trong giỏ hàng của user
produces:
- application/json
parameters:
- in: query
name: skip
description: number of records to skip for pagination
type: integer
format: int32
minimum: 0
- in: query
name: limit
description: maximum number of records to return
type: integer
format: int32
minimum: 0
maximum: 50
responses:
200:
description: search results matching criteria
schema:
type: array
items:
$ref: '#/definitions/ProductsItem'
400:
description: bad input parameter
put:
tags:
- user
summary: Thêm sản phầm vào giỏ hàng người dùng
operationId: addCart
description: thêm sản phẩm vào giỏ hàng
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: inventoryItem
schema:
$ref: '#/definitions/ProductsItem'
responses:
200:
description: update done
400:
description: invalid input, object invalid
405:
description: an existing item already exists
delete:
tags:
- user
summary: Xóa khóa học khỏi giỏ hàng của người dùng
operationId: deleteCart
description: Xóa khóa học trong giỏ hàng người dùng
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: id
description: Xóa bỏ sản phẩm theo id sản phẩm
type: integer
format: int32
minimum: 0
responses:
200:
description: OK
/transaction:
get:
tags:
- user
- admin
summary: Danh sách toàn bộ giao dịch của một người dùng
operationId: getTransaction
description: Danh sách toàn bộ giao dịch của một người dùng
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: skip
description: number of records to skip for pagination
type: integer
format: int32
minimum: 0
- in: query
name: limit
description: maximum number of records to return
type: integer
format: int32
minimum: 0
maximum: 50
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Transaction'
/notifications:
get:
tags:
- user
summary: Danh sách toàn bộ giao dịch của một người dùng
operationId: getNotifications
description: Danh sách toàn bộ giao dịch của một người dùng
consumes:
- application/json
produces:
- application/json
parameters:
- in: query
name: skip
description: number of records to skip for pagination
type: integer
format: int32
minimum: 0
- in: query
name: limit
description: maximum number of records to return
type: integer
format: int32
minimum: 0
maximum: 50
responses:
200:
description: OK
schema:
type: array
items:
$ref: '#/definitions/Notification'
definitions:
Users:
type: object
required:
- id
- urlImage
- fullname
- phoneNumber
- gender
- dob
properties:
id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
urlImage:
type: string
example: http://vinhtt.com/image/avata/04341234.jpg
email:
type: string
example: [email protected]
dob:
type: string
example: '2016-08-29T09:12:33.001Z'
fullname:
type: string
example: Trương Thế Vinh
phoneNumber:
type: string
example: 0832682626
gender:
type: string
example: Nam
ProductsItem:
type: object
required:
- id
- title
- priceOld
- priveSale
- author
- rateNumber
- rating
- isFavorite
properties:
id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
title:
type: string
example: Widget Adapter
priceOld:
type: number
example: 290000
priveSale:
type: number
example: 300000
author:
type: string
example: Jackie
rateNumber:
type: number
example: 4.5
rating:
type: number
example: 200
isFavorite:
type: boolean
example: 1
Transaction:
type: object
required:
- id
- code
- userName
- change
- transactionType
- cash
- time
properties:
id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
code:
type: string
example: Lidi456789538476
userName:
type: string
example: Nguyen Hai Nam
change:
type: number
example: -200000
transactionType:
type: string
example: mua khoa hoc
cash:
type: number
example: 2300000
time:
type: string
format: date
example: '2018-03-20T09:12:28Z'
Notification:
type: object
required:
- id
- from
- to
- shortDes
- fullDes
- time
properties:
id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
from:
type: string
example: admin
to:
type: string
example: Nguyen Hai Nam
shortDes:
type: number
example: thư mời trải nghiệm tính năng
fullDes:
type: string
example: thư mời trải nghiệm tính năng mới của hệ thống với vô số lợi ích
time:
type: string
format: date
example: '2018-03-20T09:12:28Z'
Response:
408:
description: existed value
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 408,
"message": "Existed value",
"data": null
}
407:
description: Parameter format invalid
schema:
type: object
properties:
code:
type: integer
message:
type: string
data:
type: object
example: {
"code": 407,
"message": "Parameter format invalid",
"data": null
}
406:
description: undefined error
schema:
type: object
properties:
code: