-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathswagger_schema.yml
More file actions
2699 lines (2699 loc) · 76.3 KB
/
swagger_schema.yml
File metadata and controls
2699 lines (2699 loc) · 76.3 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: DASII Backend API
version: 1.0.0
description: DASII 백엔드 API 문서
paths:
/auth/account/:
get:
operationId: auth_account_retrieve
description: 핸드폰번호를 쿼리 파라미터로 입력하여 해당 번호로 등록된 계정들을 찾습니다. access token이 없어도 사용
가능합니다.
summary: 핸드폰번호로 계정 찾기
parameters:
- in: query
name: phone_number
schema:
type: string
pattern: ^01[0-9]-?\d{3,4}-?\d{4}$
description: '핸드폰번호 (예: 010-1234-5678)'
required: true
tags:
- 계정 관리
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneNumberFindAccountResponse'
examples:
계정찾기성공:
value:
success: true
accounts:
- id: 1
email: user@example.com
nickname: user123456
login_type: email
- id: 2
email: kakao@example.com
nickname: kakao_user
login_type: kakao
message: 해당 핸드폰번호로 등록된 계정을 찾았습니다.
summary: 계정 찾기 성공
계정없음:
value:
success: true
accounts: []
message: 해당 핸드폰번호로 등록된 계정이 없습니다.
summary: 계정 없음
description: 계정 찾기 성공
'400':
description: 잘못된 요청 데이터
/auth/apple/:
post:
operationId: auth_apple_create
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AppleSigninRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AppleSigninRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/AppleSigninRequest'
required: true
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AppleSignin'
description: ''
/auth/delete/:
delete:
operationId: auth_delete_destroy
description: 현재 로그인한 사용자의 계정을 완전히 삭제합니다. 카카오/애플 연동 계정인 경우 해당 서비스에서도 탈퇴 처리합니다.
summary: 회원탈퇴
tags:
- 계정 관리
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserDeleteResponse'
examples:
탈퇴성공:
value:
success: true
message: 회원탈퇴가 완료되었습니다.
deleted_user_id: 1
deleted_email: user@example.com
summary: 탈퇴 성공
description: 회원탈퇴 성공
'400':
description: 회원탈퇴 실패
'401':
description: 인증되지 않은 사용자
/auth/email/check/:
post:
operationId: auth_email_check_create
description: 입력된 이메일이 시스템에 등록되어 있는지 확인합니다.
summary: 이메일 존재 여부 확인
tags:
- 계정 관리
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmailCheckRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EmailCheckRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/EmailCheckRequestRequest'
required: true
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EmailCheckResponse'
examples:
이메일존재함:
value:
success: true
email: user@example.com
exists: true
message: 해당 이메일이 등록되어 있습니다.
summary: 이메일 존재함
이메일없음:
value:
success: true
email: nonexistent@example.com
exists: false
message: 해당 이메일이 등록되어 있지 않습니다.
summary: 이메일 없음
description: 이메일 확인 성공
'400':
description: 잘못된 요청 데이터
/auth/email/password/reset/:
post:
operationId: auth_email_password_reset_create
description: 이메일과 새 비밀번호를 받아서 해당 계정의 비밀번호를 변경합니다. 인증번호 검증 토큰이 필요합니다. (비밀번호 찾기/재설정용)
summary: 이메일 기반 비밀번호 재설정
tags:
- 계정 관리
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmailPasswordResetRequestRequest'
examples:
요청예시:
value:
email: user@example.com
new_password1: newPassword123!
new_password2: newPassword123!
verification_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...
summary: 요청 예시
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/EmailPasswordResetRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/EmailPasswordResetRequestRequest'
required: true
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EmailPasswordResetResponse'
examples:
비밀번호재설정성공:
value:
success: true
email: user@example.com
user_id: 1
message: 비밀번호가 성공적으로 재설정되었습니다.
summary: 비밀번호 재설정 성공
description: 비밀번호 재설정 성공
'400':
description: 비밀번호 재설정 실패
/auth/kakao/logout/:
post:
operationId: auth_kakao_logout_create
description: 카카오 계정 사용자의 서버 로그아웃을 처리합니다. 카카오 로그아웃은 프론트엔드에서 window.Kakao.Auth.logout()으로
처리해주세요.
summary: 카카오 로그아웃
tags:
- 인증
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KakaoLogoutRequestRequest'
examples:
요청예시(body없음):
value: {}
summary: 요청 예시 (body 없음)
요청예시(카카오토큰포함):
value:
kakao_access_token: 카카오에서_발급받은_access_token
summary: 요청 예시 (카카오 토큰 포함)
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/KakaoLogoutRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/KakaoLogoutRequestRequest'
security:
- jwtAuth: []
responses:
'200':
description: 카카오 로그아웃 성공
'400':
description: 카카오 로그아웃 실패
'401':
description: 인증되지 않은 사용자
/auth/kakao/token/:
post:
operationId: auth_kakao_token_create
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KakaoLoginRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/KakaoLoginRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/KakaoLoginRequest'
required: true
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/KakaoLogin'
description: ''
/auth/logout/:
post:
operationId: auth_logout_create
description: 사용자를 로그아웃합니다. refresh 토큰 쿠키를 삭제합니다.
summary: 로그아웃
tags:
- 인증
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
description: 로그아웃 성공
examples:
application/json:
success: true
message: 로그아웃되었습니다.
description: ''
'400':
content:
application/json:
schema:
description: 잘못된 요청 데이터
examples:
application/json:
error: 로그아웃 실패
description: ''
'401':
content:
application/json:
schema:
description: 인증되지 않은 사용자
description: ''
/auth/mypage/:
get:
operationId: auth_mypage_retrieve
description: 현재 로그인한 사용자의 마이페이지 정보를 조회합니다. 닉네임, 이메일, 로그인 방식, 리뷰 개수를 반환합니다.
summary: 마이페이지 사용자 정보 조회
tags:
- 마이페이지
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MyPageUserInfoResponse'
examples:
성공예시:
value:
success: true
user_info:
nickname: 사용자123
email: user@example.com
login_type: kakao
review_count: 5
summary: 성공 예시
description: 마이페이지 사용자 정보 조회 성공
'401':
description: 인증되지 않은 사용자
/auth/nickname/:
patch:
operationId: auth_nickname_partial_update
description: 현재 로그인한 사용자의 닉네임을 변경합니다.
summary: 닉네임 변경
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedNicknameUpdateRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedNicknameUpdateRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedNicknameUpdateRequestRequest'
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/NicknameUpdateResponse'
description: ''
'400':
content:
application/json:
schema:
description: 유효성 오류
examples:
application/json:
nickname:
- 이미 사용 중인 닉네임입니다.
description: ''
'401':
content:
application/json:
schema:
description: 인증 필요
description: ''
/auth/password/:
post:
operationId: auth_password_create
description: 현재 사용자의 비밀번호를 변경합니다. (email 로그인 사용자만 가능)
summary: 비밀번호 변경
tags:
- 사용자 관리
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordChangeRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PasswordChangeRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PasswordChangeRequestRequest'
required: true
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordChangeResponse'
examples:
비밀번호변경성공:
value:
success: true
user_id: 1
message: 비밀번호가 성공적으로 변경되었습니다.
summary: 비밀번호 변경 성공
description: 비밀번호 변경 성공
'400':
description: 비밀번호 변경 실패
'401':
description: 인증되지 않은 사용자
/auth/password/reset/:
post:
operationId: auth_password_reset_create
description: 현재 비밀번호를 확인하고 새로운 비밀번호로 변경합니다. 계정 찾기 후 비밀번호 변경용 API입니다.
summary: 비밀번호 재설정
tags:
- 계정 관리
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PasswordResetRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PasswordResetRequestRequest'
required: true
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PasswordResetResponse'
examples:
비밀번호재설정성공:
value:
success: true
user_id: 1
message: 비밀번호가 성공적으로 재설정되었습니다.
summary: 비밀번호 재설정 성공
description: 비밀번호 재설정 성공
'400':
description: 비밀번호 재설정 실패
'401':
description: 인증되지 않은 사용자
/auth/phone/account-info/:
get:
operationId: auth_phone_account_info_retrieve
description: 전화번호를 받아서 해당 번호로 가입된 계정들의 이메일과 가입일을 반환합니다.
summary: 전화번호로 계정 정보 조회
parameters:
- in: query
name: phone_number
schema:
type: string
description: '전화번호 (다양한 형식 지원: 010-1234-5678, 01012345678, +82-10-1234-5678
등)'
required: true
tags:
- 계정 관리
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneNumberAccountInfoResponse'
examples:
성공예시-계정있음:
value:
success: true
phone_number: 01023086047
accounts:
- email: user1@example.com
created_at: '2024-01-15T10:30:00Z'
- email: user2@example.com
created_at: '2024-01-20T15:45:00Z'
message: 총 2개의 계정을 찾았습니다.
summary: 성공 예시 - 계정 있음
성공예시-계정없음:
value:
success: true
phone_number: 01023086047
accounts: []
message: 해당 전화번호로 가입된 계정이 없습니다.
summary: 성공 예시 - 계정 없음
description: 계정 정보 조회 성공
'400':
description: 잘못된 요청 데이터
/auth/send/:
post:
operationId: auth_send_create
description: 전화번호로 인증번호(6자리)를 발송합니다.
summary: 전화번호 인증 발송
tags:
- 전화번호 인증
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneSendRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PhoneSendRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PhoneSendRequestRequest'
required: true
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
original_phone:
type: string
parsed_phone:
type: string
message:
type: string
remaining_requests:
type: integer
sent_at:
type: string
verification_code:
type: string
description: ''
'400':
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: ''
'429':
content:
application/json:
schema:
type: object
properties:
error:
type: string
remaining_requests:
type: integer
description: ''
'500':
content:
application/json:
schema:
type: object
properties:
error:
type: string
details:
type: string
description: ''
/auth/signin/:
post:
operationId: auth_signin_create
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SignInRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SignInRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SignInRequest'
required: true
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SignIn'
description: ''
/auth/signup/:
post:
operationId: auth_signup_create
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SignUpRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/SignUpRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/SignUpRequest'
required: true
security:
- {}
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/SignUp'
description: ''
/auth/token/refresh/:
post:
operationId: auth_token_refresh_create
description: |-
Takes a refresh type JSON web token and returns an access type JSON web
token if the refresh token is valid.
tags:
- auth
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefreshRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TokenRefreshRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/TokenRefreshRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TokenRefresh'
description: ''
/auth/token/verify/:
post:
operationId: auth_token_verify_create
description: 프론트엔드에서 받은 verification_token을 검증합니다.
summary: 인증 토큰 검증
tags:
- 전화번호 인증
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerificationTokenRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/VerificationTokenRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/VerificationTokenRequestRequest'
required: true
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
description: 토큰 검증 성공
type: object
properties:
valid:
type: boolean
phone_number:
type: string
expires_at:
type: string
description: ''
'400':
content:
application/json:
schema:
description: 토큰 검증 실패
type: object
properties:
valid:
type: boolean
error:
type: string
description: ''
/auth/verify/:
post:
operationId: auth_verify_create
description: 전화번호와 인증번호를 검증합니다. (유효기간 3분)
summary: 인증번호 검증
tags:
- 전화번호 인증
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PhoneVerifyRequestRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PhoneVerifyRequestRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PhoneVerifyRequestRequest'
required: true
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
message:
type: string
verification_token:
type: string
description: 5분 유효한 인증용 JWT 토큰
expires_at:
type: string
description: 토큰 만료 시간
expires_in_seconds:
type: integer
description: 토큰 만료까지 남은 시간(초)
description: ''
'400':
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: ''
/products/{id}/:
get:
operationId: products_retrieve
summary: 제품 상세 조회
parameters:
- in: path
name: id
schema:
type: integer
required: true
tags:
- 제품
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProductDetail'
description: ''
/products/add/:
post:
operationId: products_add_create
summary: 제품 등록
tags:
- 제품
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/ProductCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ProductCreateRequest'
required: true
security:
- jwtAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ProductCreate'
description: ''
/products/category/:
get:
operationId: products_category_list
summary: 카테고리 조회
tags:
- 제품
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Category'
description: ''
/products/list/:
get:
operationId: products_list_list
summary: 제품 리스트 조회
parameters:
- in: query
name: bigCategory
schema:
type: string
description: '대분류 카테고리 이름(예: 다이어트 약, 다이어트 식품 등). 기본: 다이어트 약'
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- in: query
name: smallCategory
schema:
type: string
description: '소분류 카테고리 이름(예: 전체, 체지방 관리 등). 기본: 전체'
- in: query
name: sort
schema:
type: string
enum:
- monthly_rank
- review_desc
description: '정렬: monthly_rank | review_desc (기본:
monthly_rank)'
tags:
- 제품
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProductsListList'
description: ''
/products/main/:
get:
operationId: products_main_retrieve
summary: 메인 화면
tags:
- 제품
security:
- jwtAuth: []
- {}
responses:
'200':
description: No response body
/products/ranking/:
get:
operationId: products_ranking_list
summary: 랭킹 조회
parameters:
- in: query
name: category
schema:
type: string
description: '카테고리 이름 (예: 전체, 체지방 관리 등). 기본: 전체'
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- in: query
name: period
schema:
type: string
enum:
- daily
- monthly
description: '랭킹 기간 (기본: daily)'
tags:
- 제품
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProductRankingList'
description: ''
/products/search/:
get:
operationId: products_search_list
summary: 제품 검색
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- in: query
name: sort
schema:
type: string
enum:
- monthly_rank
- review_desc
description: '정렬: monthly_rank | review_desc (기본:
monthly_rank)'
- in: query
name: word
schema:
type: string
description: 검색어(제품명, 회사명, 기능성 원료명)
tags:
- 제품
security:
- jwtAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProductSearchList'
description: ''
/review/{review_id}/:
patch:
operationId: review_partial_update
description: 작성한 리뷰를 수정합니다.
summary: 리뷰 수정
parameters:
- in: path
name: review_id
schema:
type: integer
required: true
tags:
- 리뷰
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedReviewRequest'
examples:
리뷰수정요청:
value:
rate: 4
review: 품질은 좋지만 가격이 조금 아쉬워요. 그래도 추천합니다.
summary: 리뷰 수정 요청
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedReviewRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedReviewRequest'
security:
- jwtAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ReviewUpdateResponse'
examples:
리뷰수정요청:
value:
rate: 4
review: 품질은 좋지만 가격이 조금 아쉬워요. 그래도 추천합니다.
summary: 리뷰 수정 요청
성공예시:
value:
message: 리뷰가 성공적으로 수정되었습니다.
review_id: 1
user_id: 1
product_id: 1
rate: 4
review: 품질은 좋지만 가격이 조금 아쉬워요. 그래도 추천합니다.
summary: 성공 예시
description: 리뷰 수정 성공
'400':
description: 잘못된 요청 데이터
'401':
description: 인증되지 않은 사용자
'404':
description: 리뷰를 찾을 수 없음
/review/{review_id}/delete/:
delete:
operationId: review_delete_destroy
description: 작성한 리뷰를 삭제합니다. 본인이 작성한 리뷰만 삭제 가능합니다.