Skip to content

Commit f062341

Browse files
authored
Merge pull request #27 from sudo-Terry/doc/api-documentation
doc: API 문서 수정
2 parents 8da7dfc + 19a364c commit f062341

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

‎src/main/java/team3/kummit/controller/EmotionBandController.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public class EmotionBandController {
3232
@PostMapping()
3333
@Operation(
3434
summary = "새 감정밴드 생성",
35-
description = "새로운 감정밴드를 생성합니다. 사용자 ID는 선택사항입니다.",
35+
description = "새로운 감정밴드를 생성합니다.",
3636
tags = {"EmotionBand"}
3737
)
3838
@ApiResponses(value = {
@@ -41,7 +41,7 @@ public class EmotionBandController {
4141
@ApiResponse(responseCode = "500", description = "서버 오류")
4242
})
4343
public ResponseEntity<EmotionBandCreateResponse> createEmotionBand(
44-
@Parameter(description = "사용자 ID (선택사항)") @RequestParam(required = false) Long memberId,
44+
@Parameter(description = "사용자 ID") @RequestParam(required = true) Long memberId,
4545
@RequestBody EmotionBandCreateRequest emotionBandCreateRequest) {
4646
Long emotionBandId = emotionBandService.createEmotionBand(memberId, emotionBandCreateRequest);
4747
return ResponseEntity.status(HttpStatus.CREATED).body(new EmotionBandCreateResponse(emotionBandId));

‎src/main/java/team3/kummit/controller/MemberController.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public ResponseEntity<MemberLoginResponse> memberLogin(
6161
summary = "회원 프로필 조회",
6262
description = "회원 ID를 통해 회원의 프로필 정보를 조회합니다. 회원 가입 날짜, 밴드 생성/참여 횟수, 좋아요 수, 추가한 곡 수 등의 정보를 반환합니다.",
6363
parameters = {
64-
@Parameter(name = "memberId", description = "사용자 ID (선택사항)", required = false)
64+
@Parameter(name = "memberId", description = "사용자 ID", required = true)
6565
}
6666
)
6767
@ApiResponses(value = {
@@ -70,7 +70,7 @@ public ResponseEntity<MemberLoginResponse> memberLogin(
7070
})
7171
@GetMapping("/profile")
7272
public ResponseEntity<MemberProfileResponse> memberProfileGet(
73-
@Parameter(description = "사용자 ID (선택사항)") @RequestParam Long memberId) {
73+
@Parameter(description = "사용자 ID") @RequestParam Long memberId) {
7474
Member member = memberService.findById(memberId);
7575
return ResponseEntity.status(HttpStatus.CREATED).body(new MemberProfileResponse(
7676
member.getName(),
@@ -85,7 +85,7 @@ public ResponseEntity<MemberProfileResponse> memberProfileGet(
8585
summary = "사용자가 생성한 감정 밴드 목록 조회",
8686
description = "사용자의 ID를 전달받아, 해당 사용자가 생성한 감정 밴드 목록을 조회합니다. 조회된 감정 밴드의 상세 정보가 포함됩니다.",
8787
parameters = {
88-
@Parameter(name = "memberId", description = "사용자 ID (선택사항)", required = false)
88+
@Parameter(name = "memberId", description = "사용자 ID", required = true)
8989
}
9090
)
9191
@ApiResponses(value = {
@@ -105,7 +105,7 @@ public ResponseEntity<MemberBandResponse> memberMyBand(
105105
summary = "사용자가 공감한 감정 밴드 목록 조회",
106106
description = "사용자의 ID를 전달받아, 해당 사용자가 공감한 감정 밴드 목록을 조회합니다. 조회된 감정 밴드의 상세 정보가 포함됩니다.",
107107
parameters = {
108-
@Parameter(name = "memberId", description = "사용자 ID (선택사항)", required = false)
108+
@Parameter(name = "memberId", description = "사용자 ID", required = true)
109109
}
110110
)
111111
@ApiResponses(value = {
@@ -126,7 +126,7 @@ public ResponseEntity<MemberBandResponse> memberLikeBand(
126126
summary = "사용자가 저장한 감정 밴드 목록 조회",
127127
description = "사용자의 ID를 전달받아, 해당 사용자가 저장한 감정 밴드 목록을 조회합니다. 조회된 감정 밴드의 상세 정보가 포함됩니다.",
128128
parameters = {
129-
@Parameter(name = "memberId", description = "사용자 ID (선택사항)", required = false)
129+
@Parameter(name = "memberId", description = "사용자 ID", required = true)
130130
}
131131
)
132132
@ApiResponses(value = {

0 commit comments

Comments
 (0)