forked from peter-evans/swagger-github-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswagger.yaml
More file actions
2328 lines (2215 loc) · 55 KB
/
swagger.yaml
File metadata and controls
2328 lines (2215 loc) · 55 KB
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: TRIT API
version: 1.0.0
servers:
- url: https://localhost:8080
description: Local server
tags:
- name: auth
description: 인증 관련 API
- name: ai
description: AI 관련 API
- name: search
description: 검색 관련 API
- name: trip
description: 여행 관련 API
- name: spot
description: 장소 관련 API
- name: spot-review
description: 장소 리뷰 관련 API
- name: triplog
description: 여행 기록 관련 API
- name: trip-log-comment
description: 여행 기록 댓글 관련 API
- name: user
description: 사용자 관련 API
- name: friend
description: 친구 관련 API
- name: notification
description: 알림 관련 API
paths:
/ai/chat:
post:
tags: [ai]
summary: AI 챗봇 (여행 코스 점검, 추천, 대화)
description: |
- 제공된 메시지 리스트(messages)를 그대로 AI에게 전달하여 응답을 받습니다.
- System Prompt, 이전 대화 내역 등 모든 컨텍스트는 Client가 구성해서 보내야 합니다.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AiChatRequestDto'
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/AiChatResponseDto'
/ai/recommend-spot:
post:
tags: [ai]
summary: 장소 추천 (AI)
description: |
- 현재 여행 코스에 어울리는 최적의 장소를 후보군 중에서 선택하여 추천합니다.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AiSpotRecommendRequestDto'
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/AiSpotRecommendResponseDto'
/ai/check-course:
post:
tags: [ai]
summary: 코스 점검 (AI)
description: |
- 제공된 코스(장소 리스트)를 분석하여 동선 효율성 및 카테고리 밸런스 등을 점검합니다.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AiCourseCheckRequestDto'
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/AiChatResponseDto'
/auth/login:
post:
tags: [auth]
summary: 로그인
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequestDto'
responses:
'200':
description: 로그인 성공
content:
application/json:
schema:
$ref: '#/components/schemas/LoginResponseDto'
headers:
Set-Cookie:
schema:
type: string
example: refreshToken=...; Path=/; Secure; HttpOnly; SameSite=None
'400':
description: 잘못된 요청
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/auth/logout:
post:
tags: [auth]
summary: 로그아웃
security:
- bearerAuth: []
responses:
'200':
description: 로그아웃 성공
headers:
Set-Cookie:
schema:
type: string
example: refreshToken=; Max-Age=0; Path=/; Secure; HttpOnly; SameSite=None
'401':
description: 인증 실패
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/auth/signup:
post:
tags: [auth]
summary: 회원가입
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignupRequestDto'
responses:
'201':
description: 회원가입 성공
'400':
description: 잘못된 요청
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/auth/reset-password:
post:
tags: [auth]
summary: 비밀번호 재설정 요청
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetRequestDto'
responses:
'200':
description: 성공
'400':
description: 잘못된 요청
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/auth/find-email/{nickname}:
get:
tags: [auth]
summary: 닉네임으로 이메일 찾기
parameters:
- name: nickname
in: path
required: true
schema:
type: string
responses:
'200':
description: 성공
content:
application/json:
schema:
type: object
properties:
email:
type: string
'404':
description: 사용자를 찾을 수 없음
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/auth/refresh:
post:
tags: [auth]
summary: Access Token 갱신
parameters:
- name: refreshToken
in: cookie
required: true
schema:
type: string
responses:
'200':
description: 토큰 갱신 성공
content:
application/json:
schema:
$ref: '#/components/schemas/TokenResponseDto'
headers:
Set-Cookie:
schema:
type: string
example: refreshToken=...; Path=/; Secure; HttpOnly; SameSite=None
'401':
description: 유효하지 않은 Refresh Token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/search/spots:
get:
tags: [search]
summary: 장소 검색
parameters:
- name: q
in: query
required: true
schema:
type: string
responses:
'200':
description: 성공
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpotSearchDoc'
/search/trip-logs:
get:
tags: [search]
summary: 여행 기록 검색
parameters:
- name: q
in: query
required: true
schema:
type: string
responses:
'200':
description: 성공
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TripLogSearchDoc'
/search/trips:
get:
tags: [search]
summary: 여행 검색
parameters:
- name: q
in: query
required: true
schema:
type: string
responses:
'200':
description: 성공
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TripSearchDoc'
/trips:
post:
tags: [trip]
summary: 여행 생성
security:
- bearerAuth: []
responses:
'201':
description: 여행 생성 성공
content:
application/json:
schema:
$ref: '#/components/schemas/TripDetailResponseDto'
get:
tags: [trip]
summary: 내 여행 목록 조회
security:
- bearerAuth: []
parameters:
- name: status
in: query
schema:
type: string
enum: [DRAFT, PLANNED, COMPLETED]
responses:
'200':
description: 성공
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TripResponseDto'
/trips/{tripId}:
get:
tags: [trip]
summary: 여행 상세 조회
security:
- bearerAuth: []
parameters:
- name: tripId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/TripDetailResponseDto'
patch:
tags: [trip]
summary: 여행 수정
description: 모든 필드가 필요하지 않습니다. 부분적으로 업데이트가 가능합니다.
security:
- bearerAuth: []
parameters:
- name: tripId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TripUpdateRequestDto'
responses:
'200':
description: 성공
delete:
tags: [trip]
summary: 여행 삭제
security:
- bearerAuth: []
parameters:
- name: tripId
in: path
required: true
schema:
type: integer
format: int64
responses:
'204':
description: 성공
/trips/{tripId}/items:
put:
tags: [trip]
summary: 여행 아이템 교체
description: items의 필드는 spotId 또는 spot 중 하나만 쓸 수 있습니다.
security:
- bearerAuth: []
parameters:
- name: tripId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TripItemsReplaceRequestDto'
responses:
'200':
description: 성공
/trips/{tripId}/scrap:
post:
tags: [trip]
summary: 여행 스크랩 (복사)
description: 다른 사용자의 공개된 여행 또는 자신의 여행을 복사하여 내 여행으로 저장합니다.
security:
- bearerAuth: []
parameters:
- name: tripId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 스크랩 성공
content:
application/json:
schema:
type: object
properties:
tripId:
type: integer
format: int64
description: 생성된 여행 ID
/trip-logs/images/presigned-url:
post:
tags: [triplog]
summary: 이미지 업로드용 Presigned URL 생성
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImageUploadRequestDto'
responses:
'200':
description: |
생성 성공
[주의사항]
1. 리턴받은 `presignedUrl`로 PUT 요청을 보내야 합니다.
2. Request Body는 `multipart/form-data`가 아닌 **Binary**로 파일을 직접 전송해야 합니다.
3. Header에 `Content-Type: {파일확장자타입}` (예: `image/png`, `image/jpeg`)을 반드시 포함해야 합니다.
4. Header에 `x-amz-acl: public-read`를 **반드시** 포함해야 합니다.
content:
application/json:
schema:
$ref: '#/components/schemas/PresignedUrlResponseDto'
/trip-logs:
post:
tags: [triplog]
summary: 여행 기록 생성
security:
- bearerAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogCreateRequestDto'
responses:
'201':
description: 생성 성공
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogCreateResponseDto'
get:
tags: [triplog]
summary: 여행 기록 조회 (유저별 또는 장소별)
description: |
- userId 제공 시: 해당 유저의 여행 기록을 페이징(Page)하여 조회합니다.
- spotId 제공 시: 해당 장소가 포함된 여행 기록을 무한스크롤(Slice)하여 조회합니다.
- 둘 중 하나는 반드시 포함되어야 합니다.
parameters:
- name: userId
in: query
required: false
description: 유저 ID (유저별 조회 시 필수)
schema:
type: integer
format: int64
- name: spotId
in: query
required: false
description: 장소 ID (장소별 조회 시 필수)
schema:
type: integer
format: int64
- name: cursor
in: query
description: 커서 ID (장소별 조회 시 사용)
schema:
type: integer
format: int64
- name: page
in: query
description: 페이지 번호 (유저별 조회 시 사용)
schema:
type: integer
default: 1
- name: limit
in: query
description: 조회 개수
schema:
type: integer
default: 10
responses:
'200':
description: 성공
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/PageTripLogFeedResponseDto'
- $ref: '#/components/schemas/SliceTripLogFeedResponseDto'
/trip-logs/feed:
get:
tags: [triplog]
summary: 여행 기록 피드 조회
security:
- bearerAuth: []
parameters:
- name: cursor
in: query
schema:
type: integer
format: int64
- name: limit
in: query
schema:
type: integer
default: 10
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/SliceTripLogFeedResponseDto'
/trip-logs/feed/friends:
get:
tags: [triplog]
summary: 친구 피드 조회
security:
- bearerAuth: []
parameters:
- name: cursor
in: query
schema:
type: integer
format: int64
- name: limit
in: query
schema:
type: integer
default: 10
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/SliceTripLogFeedResponseDto'
/trip-logs/{logId}:
get:
tags: [triplog]
summary: 여행 기록 상세 조회
parameters:
- name: logId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogDetailResponseDto'
patch:
tags: [triplog]
summary: 여행 기록 수정
security:
- bearerAuth: []
parameters:
- name: logId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogUpdateRequestDto'
responses:
'200':
description: 성공
delete:
tags: [triplog]
summary: 여행 기록 삭제
security:
- bearerAuth: []
parameters:
- name: logId
in: path
required: true
schema:
type: integer
format: int64
responses:
'204':
description: 성공
/trip-logs/{logId}/comments:
post:
tags: [triplog]
summary: 여행 기록 댓글 추가
security:
- bearerAuth: []
parameters:
- name: logId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogCommentRequestDto'
responses:
'201':
description: 성공
/trip-logs/comments/{commentId}:
patch:
tags: [trip-log-comment]
summary: 여행 기록 댓글 수정
operationId: updateTripLogComment
parameters:
- name: commentId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogCommentRequestDto'
responses:
'200':
description: 댓글 수정 성공
'403':
description: 권한 없음 (작성자 불일치)
'404':
description: 댓글 없음
delete:
tags: [trip-log-comment]
summary: 여행 기록 댓글 삭제
operationId: deleteTripLogComment
parameters:
- name: commentId
in: path
required: true
schema:
type: integer
format: int64
responses:
'204':
description: 댓글 삭제 성공
'403':
description: 권한 없음
'404':
description: 댓글 없음
/trip-logs/{logId}/likes/status:
get:
tags: [triplog]
summary: 여행 기록 좋아요 상태 조회
security:
- bearerAuth: []
parameters:
- name: logId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogLikeResponseDto'
/trip-logs/{logId}/likes:
post:
tags: [triplog]
summary: 여행 기록 좋아요
security:
- bearerAuth: []
parameters:
- name: logId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogLikeResponseDto'
delete:
tags: [triplog]
summary: 여행 기록 좋아요 취소
security:
- bearerAuth: []
parameters:
- name: logId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/TripLogLikeResponseDto'
/spots:
get:
tags: [spot]
summary: Kakao Place ID로 장소 조회
description: |
- Kakao Place ID로 DB에 저장된 장소를 조회합니다.
- 존재하지 않으면 404 Not Found를 반환합니다.
parameters:
- name: kakaoPlaceId
in: query
required: true
schema:
type: string
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/SpotResponseDto'
'404':
description: 장소를 찾을 수 없음
post:
tags: [spot]
summary: 장소 생성 (Upsert)
description: |
- Kakao Place ID로 장소를 생성하거나 조회합니다.
- 이미 존재하면 200 OK와 함께 기존 장소 정보를 반환합니다.
- 존재하지 않으면 201 Created와 함께 새 장소를 생성하고 반환합니다.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpotRequestDto'
responses:
'200':
description: 이미 존재하는 장소 반환
content:
application/json:
schema:
$ref: '#/components/schemas/SpotResponseDto'
'201':
description: 생성 성공
content:
application/json:
schema:
$ref: '#/components/schemas/SpotResponseDto'
'409':
description: 이미 존재하는 장소
/spots/{spotId}:
get:
tags: [spot]
summary: 장소 상세 조회
parameters:
- name: spotId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/SpotResponseDto'
'404':
description: 장소를 찾을 수 없음
patch:
tags: [spot]
summary: 장소 정보 수정
parameters:
- name: spotId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpotRequestDto'
responses:
'200':
description: 수정 성공
content:
application/json:
schema:
$ref: '#/components/schemas/SpotResponseDto'
delete:
tags: [spot]
summary: 장소 삭제
parameters:
- name: spotId
in: path
required: true
schema:
type: integer
format: int64
responses:
'204':
description: 삭제 성공
'404':
description: 장소를 찾을 수 없음
/spots/{spotId}/thumbnail:
post:
tags: [spot]
summary: 장소 썸네일 업데이트 (Google Maps)
description: |
- Google Maps API를 사용하여 장소의 썸네일 이미지를 검색하고 S3에 저장합니다.
- 이미 썸네일이 존재하면 업데이트하지 않고 현재 정보를 반환합니다.
parameters:
- name: spotId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/SpotResponseDto'
'404':
description: 장소를 찾을 수 없음
/search/place:
get:
tags: [search]
summary: 키워드 장소 검색 (Kakao API)
parameters:
- name: keyword
in: query
required: true
schema:
type: string
- name: lat
in: query
required: false
schema:
type: number
format: double
- name: lng
in: query
required: false
schema:
type: number
format: double
responses:
'200':
description: 성공
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpotResponseDto'
/spots/hot:
get:
tags: [spot]
summary: Hot Place Top 10 조회
description: 여행 계획에 가장 많이 추가된 상위 10개 장소를 조회합니다. (10분 캐싱)
responses:
'200':
description: 조회 성공
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpotResponseDto'
/spot-reviews/me:
get:
tags: [spot-review]
summary: 내 리뷰 목록 조회 (필터링 가능)
description: |
- 로그인한 사용자가 작성한 리뷰 목록을 조회합니다.
- spotId 파라미터가 있으면 해당 장소에 대한 리뷰만 반환합니다 (0개 또는 1개).
- spotId 파라미터가 없으면 사용자가 작성한 모든 리뷰를 반환합니다.
security:
- bearerAuth: []
parameters:
- name: spotId
in: query
required: false
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SpotReviewResponseDto'
/spot-reviews:
get:
tags: [spot-review]
summary: 장소 리뷰 목록 조회
parameters:
- name: spotId
in: query
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 성공
content:
application/json:
schema:
$ref: '#/components/schemas/SpotReviewListResponseDto'
post:
tags: [spot-review]
summary: 장소 리뷰 생성
security:
- bearerAuth: []
requestBody:
content: