-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathopenapi.yaml
1236 lines (1151 loc) · 42.9 KB
/
openapi.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
openapi: 3.0.3
info:
title: Cow of Answer
version: 1.0.0
tags:
- name: User
description: 與使用者有關的路由
- name: ChallengeRecord
description: 與關卡紀錄有關的路由
- name: Authenticate
description: 與驗證有關的路由
- name: Achievement
description: 與成就有關的路由
- name: RankList
description: 與排行榜有關的路由
- name: Book
description: 與答案之書有關的路由
- name: UserAchievement
description: 與使用者獲得成就有關的路由
paths:
/api/user:
get:
summary: 取得所有使用者 (後台使用)
tags:
- User
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/UserNameList"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者帳號或密碼錯誤
"404":
description: 找不到使用者
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 資料庫內沒有使用者
security:
- jwt: []
/api/user/{user_id}:
get:
summary: 取得特定使用者 (後台使用)
tags:
- User
parameters:
- in: path
name: user_id
required: true
description: 使用者的ID
schema:
type: integer
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/UserUpdateResult"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者帳號或密碼錯誤
"404":
description: 找不到使用者
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者未註冊
security:
- jwt: []
put:
summary: 更新特定使用者 (後台使用)
tags:
- User
parameters:
- in: path
name: user_id
required: true
description: 使用者的ID
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdate'
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/UserUpdateResult"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者帳號或密碼錯誤
"404":
description: 找不到使用者
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者未註冊
security:
- jwt: []
delete:
summary: 刪除特定使用者 (後台使用)
tags:
- User
parameters:
- in: path
name: user_id
required: true
description: 使用者的ID
schema:
type: integer
responses:
"204":
description: 無內容
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者帳號或密碼錯誤
"404":
description: 找不到使用者
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者未註冊
security:
- jwt: []
/api/challenge-record:
post:
summary: 創建使用者通關紀錄 (時間)
tags:
- ChallengeRecord
description:
當使用者通關時呼叫，會根據傳入的使用者 ID 與關卡編號去建立使用者與關卡的關聯，並記錄使用者通關時間 (以秒為單位)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RecordCreate'
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/RecordCreate"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者帳號或密碼錯誤
"404":
description: 找不到使用者
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者未註冊
security:
- jwt: []
/api/challenge-record/{challengeRecord-id}:
delete:
summary: 刪除使用者通關紀錄 (後台使用)
tags:
- ChallengeRecord
parameters:
- in: path
name: challengeRecord-id
required: true
description: 通關紀錄的 ID
schema:
type: integer
responses:
"204":
description: 無內容
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者帳號或密碼錯誤
"404":
description: 找不到通關紀錄
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 找不到通關紀錄
security:
- jwt: []
/api/auth/login:
post:
summary: 使用者登陸 (獲取 Token)
tags:
- Authenticate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserLogin'
responses:
"200":
description: 成功
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 代表登入成功
user:
$ref: "#/components/schemas/User"
token:
type: string
description: 用來做 JWT Token 的驗證
"401":
description: 密碼錯誤
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者帳號或密碼錯誤
"404":
description: 找不到使用者
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者未註冊
/api/auth/register:
post:
summary: 使用者註冊 (包含建立使用者)
tags:
- Authenticate
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserRegister'
responses:
"200":
description: 成功
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 代表使用者創建成功
user:
$ref: "#/components/schemas/User"
token:
type: string
description: 用來做 JWT Token 的驗證
"409":
description: 使用者email重複
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者email已存在資料庫
/api/auth/refresh:
get:
summary: 使用者 Token 刷新 (時效重置)
description: 設想情境，你不會希望自己還在玩遊戲然後突然要求你去登入，所以你們要討論出一個固定的行為，例如每次進入關卡時都會呼叫此端口，以確保 Token 時效不會過期
tags:
- Authenticate
responses:
"200":
description: 成功
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 代表使用者創建成功
user:
$ref: "#/components/schemas/User"
token:
type: string
description: 用來做 JWT Token 的驗證
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 用來做 JWT Token 的驗證
security:
- jwt: []
/api/auth/logout:
get:
summary: 使用者登出 (移除 Token 效用)
description: 前端無須考慮登出的問題，使用者按下登出後呼叫此端口並重導向回初始畫面，原 Token 將無法再使用，需重新登入取得新的 Token
tags:
- Authenticate
responses:
"200":
description: 成功
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: 代表使用者創建成功
message:
type: string
description: 成功登出
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 用來做 JWT Token 的驗證
security:
- jwt: []
/api/achievement/{achievement_id}:
get:
summary: 取得特定成就 (查看詳細成就)
description: 當使用者點擊特定成就進入該成就頁面時呼叫，會回傳該成就的 description，在此之前應妥善利用先前得到的所有成就的資訊
tags:
- Achievement
parameters:
- in: path
name: achievement_id
required: true
description: 想取得成就的 ID
schema:
type: integer
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/DetailAchievement"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 成就不存在
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 成就不存在資料庫內
security:
- jwt: []
put:
summary: 更新特定成就 (後台使用)
tags:
- Achievement
parameters:
- in: path
name: achievement_id
required: true
description: 想更新成就的 ID
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AchievementCreate'
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/Achievement"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 資料庫內沒有成就
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 資料庫內沒有成就
security:
- jwt: []
delete:
summary: 刪除特定成就 (後台使用)
tags:
- Achievement
parameters:
- in: path
name: achievement_id
required: true
description: 想獲取成就的 ID
schema:
type: integer
responses:
"204":
description: 無內容
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 資料庫內沒有成就
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 資料庫內沒有成就
security:
- jwt: []
/api/achievement:
post:
summary: 新增成就 (後台使用)
description: image 請放入可使用的線上「圖片連結」
tags:
- Achievement
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AchievementCreate'
responses:
"201":
description: 已建立
content:
application/json:
schema:
$ref: "#/components/schemas/Achievement"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"422":
description: 創建成就失敗
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 創建成就失敗
security:
- jwt: []
get:
summary: 取得所有成就 (查看總成就欄使用)
description: 在使用者點進成就頁面時呼叫，會回傳除了 description 以外的資訊，image 將採用線上連結
tags:
- Achievement
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/AchievementList"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 資料庫內沒有成就
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 資料庫內沒有成就
security:
- jwt: []
/api/user-achievement:
post:
summary: 使用者獲取特定成就
description: 獲得成就時呼叫，會根據傳入的使用者 ID 與成就 ID 去建立使用者與成就的關聯
tags:
- UserAchievement
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserAchievementCreate'
responses:
"201":
description: 已建立
content:
application/json:
schema:
$ref: "#/components/schemas/UserAchievementResponse"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"409":
description: 此映射已存在
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 此映射已存在
security:
- jwt: []
get:
summary: 查看使用者已獲得成就
description: 會根據當前 Token 去抓取使用者獲得的成就 ID，不需要傳入參數 (請前端自行計算總數量)
tags:
- UserAchievement
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/AchievementRankList"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 使用者沒有已獲得成就
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者沒有已獲得成就
security:
- jwt: []
/api/user-achievement/{user_achievement_id}:
delete:
summary: 刪除特定使用者成就關聯 (後台使用)
tags:
- UserAchievement
parameters:
- in: path
name: user_achievement_id
required: true
description: 映射的 ID
schema:
type: integer
responses:
"204":
description: 無內容
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 此映射不存在
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 此映射不存在
security:
- jwt: []
/api/rank-list/{challenge_number}:
get:
summary: 獲得排行榜資訊
description: 會根據傳入的關卡編號去抓取該關卡的前 10 名資訊，若資料不足10筆則只會回傳現有資料，回傳的資料已經過排序
tags:
- RankList
parameters:
- in: path
name: challenge_number
required: true
description: 關卡的編號 (e.g 1, 2, 3)
schema:
type: integer
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/ChallengeRankList"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 沒有找到排行榜
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 沒有找到排行榜
security:
- jwt: []
/api/rank-list/rank/user:
get:
summary: 獲得使用者排行榜資訊
description: 會根據當前 Token 去抓取使用者 1 至 3 關的最佳通關時間，不需要傳入參數
tags:
- RankList
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/UserRankList"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 使用者沒有通關紀錄
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 使用者沒有通關紀錄
security:
- jwt: []
/api/book:
get:
summary: 取得所有答案 (後台使用)
tags:
- Book
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/AnswerList"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 沒有找到答案
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 沒有找到答案
security:
- jwt: []
post:
summary: 創建新答案 (後台使用)
tags:
- Book
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnswerCreate'
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/Answer"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"409":
description: 答案已存在
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 答案已存在
security:
- jwt: []
/api/book/{book_id}:
delete:
summary: 刪除特定答案 (後台使用)
tags:
- Book
parameters:
- in: path
name: book_id
required: true
description: 答案的編號
schema:
type: integer
responses:
"204":
description: 無內容
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 沒有找到答案
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 沒有找到答案
security:
- jwt: []
/api/book/answer:
get:
summary: 取得隨機答案
tags:
- Book
responses:
"200":
description: 成功
content:
application/json:
schema:
$ref: "#/components/schemas/Answer"
"401":
description: 使用者 Token 不合格
content:
application/json:
schema:
$ref: "#/components/schemas/JwtError"
"404":
description: 沒有找到答案
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: 沒有找到答案
security:
- jwt: []
components:
schemas:
User:
type: object
properties:
id:
type: integer
description: 使用者id
name:
type: string
description: 使用者名稱
email:
type: string
description: 使用者email
password:
type: string
description: 使用者密碼
required:
- id
- name
- email
- password
UserUpdateResult:
type: object
properties:
id:
type: integer
description: 使用者id
name:
type: string
description: 使用者名稱
email:
type: string
description: 使用者email
required:
- id
- name
- email
UserUpdate:
type: object
properties:
name:
type: string
description: 使用者名稱
email:
type: string
description: 使用者email
required:
- name
- email
UserNameList:
type: array
items:
type: object
properties:
name:
type: string
description: 使用者名稱