Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

πŸ“ Docs: API λͺ…μ„Έ 보완 #81

Merged
merged 1 commit into from
Jul 10, 2024
Merged

πŸ“ Docs: API λͺ…μ„Έ 보완 #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/main/java/treehouse/server/api/comment/presentation/CommentApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public CommonResponse reportComment(
return CommonResponse.onSuccess(null);
}

@Operation(summary = "λŒ“κΈ€ λͺ©λ‘ 쑰회 API πŸ”‘", description = "λŒ“κΈ€ λͺ©λ‘μ„ μ‘°νšŒν•˜λŠ” API μž…λ‹ˆλ‹€.")
@Operation(summary = "λŒ“κΈ€ λͺ©λ‘ 쑰회 API πŸ”‘ βœ…", description = "λŒ“κΈ€ λͺ©λ‘μ„ μ‘°νšŒν•˜λŠ” API μž…λ‹ˆλ‹€.")
@GetMapping()
public CommonResponse<CommentResponseDTO.CommentListDto> getComments(
@PathVariable(name = "treehouseId") Long treehouseId,
Expand All @@ -50,7 +50,7 @@ public CommonResponse<CommentResponseDTO.CommentListDto> getComments(
}

@PostMapping("")
@Operation(summary = "λŒ“κΈ€ μž‘μ„± API πŸ”‘", description = "νŠΉμ • Post에 λŒ€ν•΄μ„œ λŒ“κΈ€μ„ μž‘μ„±ν•˜λŠ” API μž…λ‹ˆλ‹€.")
@Operation(summary = "λŒ“κΈ€ μž‘μ„± API πŸ”‘ βœ…", description = "νŠΉμ • Post에 λŒ€ν•΄μ„œ λŒ“κΈ€μ„ μž‘μ„±ν•˜λŠ” API μž…λ‹ˆλ‹€.")
public CommonResponse<CommentResponseDTO.CommentIdResponseDto> createComment(
@PathVariable(name = "treehouseId")Long treehouseId,
@PathVariable(name = "postId")Long postId,
Expand All @@ -62,7 +62,7 @@ public CommonResponse<CommentResponseDTO.CommentIdResponseDto> createComment(
}

@PostMapping("/{commentId}")
@Operation(summary = "λŒ€λŒ“κΈ€ μž‘μ„± API πŸ”‘", description = "νŠΉμ • Comment에 λŒ€ν•΄μ„œ λŒ€λŒ“κΈ€μ„ μž‘μ„±ν•˜λŠ” API μž…λ‹ˆλ‹€.")
@Operation(summary = "λŒ€λŒ“κΈ€ μž‘μ„± API πŸ”‘ βœ…", description = "νŠΉμ • Comment에 λŒ€ν•΄μ„œ λŒ€λŒ“κΈ€μ„ μž‘μ„±ν•˜λŠ” API μž…λ‹ˆλ‹€.")
public CommonResponse<CommentResponseDTO.CommentIdResponseDto> createReply(
@PathVariable(name = "treehouseId")Long treehouseId,
@PathVariable(name = "postId")Long postId,
Expand All @@ -75,7 +75,7 @@ public CommonResponse<CommentResponseDTO.CommentIdResponseDto> createReply(
}

@DeleteMapping("/{commentId}")
@Operation(summary = "λŒ“κΈ€ μ‚­μ œ API πŸ”‘", description = "λŒ“κΈ€μ„ μ‚­μ œν•˜λŠ” API μž…λ‹ˆλ‹€.")
@Operation(summary = "λŒ“κΈ€ μ‚­μ œ API πŸ”‘ βœ…", description = "λŒ“κΈ€μ„ μ‚­μ œν•˜λŠ” API μž…λ‹ˆλ‹€.")
public CommonResponse deleteComment(
@PathVariable(name = "treehouseId")Long treehouseId,
@PathVariable(name = "postId")Long postId,
Expand All @@ -88,7 +88,7 @@ public CommonResponse deleteComment(
}

@PostMapping("/{commentId}/reactions")
@Operation(summary = "λŒ“κΈ€ λ°˜μ‘ API πŸ”‘", description = "λŒ“κΈ€μ— κ°μ •ν‘œν˜„μ„ λ‚¨κΈ°λŠ” API μž…λ‹ˆλ‹€.")
@Operation(summary = "λŒ“κΈ€ λ°˜μ‘ API πŸ”‘ βœ…", description = "λŒ“κΈ€μ— κ°μ •ν‘œν˜„μ„ λ‚¨κΈ°λŠ” API μž…λ‹ˆλ‹€.")
public CommonResponse<String> reactToComment(
@PathVariable(name = "treehouseId")Long treehouseId,
@PathVariable(name = "postId")Long postId,
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/treehouse/server/api/member/presentation/MemberApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public class MemberApi {
private final PostService postService;

@PostMapping("/members/register")
@Operation(summary = "νŠΈλ¦¬ν•˜μš°μŠ€ νšŒμ›κ°€μž… \uD83D\uDD11βœ…", description = "νŠΈλ¦¬ν•˜μš°μŠ€ λ©€λ²„λ‘œ κ°€μž…ν•©λ‹ˆλ‹€.")
@Operation(summary = "νŠΈλ¦¬ν•˜μš°μŠ€ νšŒμ›κ°€μž… \uD83D\uDD11 πŸ”‘ βœ…", description = "νŠΈλ¦¬ν•˜μš°μŠ€ λ©€λ²„λ‘œ κ°€μž…ν•©λ‹ˆλ‹€.")
public CommonResponse<MemberResponseDTO.registerMember> registerTreehouseMember(
@RequestBody final MemberRequestDTO.registerMember request,
@AuthMember @Parameter(hidden = true) User user
Expand All @@ -36,7 +36,7 @@ public CommonResponse<MemberResponseDTO.registerMember> registerTreehouseMember(
}

@GetMapping("/treehouses/{treehouseId}/profiles/myProfile")
@Operation(summary = "λ‚΄ ν”„λ‘œν•„ 쑰회 \uD83D\uDC64 βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ λ‚΄ ν”„λ‘œν•„μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "λ‚΄ ν”„λ‘œν•„ 쑰회 \uD83D\uDC64 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ λ‚΄ ν”„λ‘œν•„μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<MemberResponseDTO.getProfile> getMyProfile(
@PathVariable final Long treehouseId,
@AuthMember @Parameter(hidden = true) User user
Expand All @@ -45,7 +45,7 @@ public CommonResponse<MemberResponseDTO.getProfile> getMyProfile(
}

@GetMapping("/treehouses/{treehouseId}/profiles/{memberId}")
@Operation(summary = "멀버 ν”„λ‘œν•„ 쑰회 \uD83D\uDC64 βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ νŠΉμ • λ©€λ²„μ˜ ν”„λ‘œν•„μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "멀버 ν”„λ‘œν•„ 쑰회 \uD83D\uDC64 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ νŠΉμ • λ©€λ²„μ˜ ν”„λ‘œν•„μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<MemberResponseDTO.getProfile> getMemberProfile(
@PathVariable(name = "treehouseId") Long treehouseId,
@PathVariable(name = "memberId") Long memberId,
Expand All @@ -56,7 +56,7 @@ public CommonResponse<MemberResponseDTO.getProfile> getMemberProfile(


@PatchMapping("/treehouses/{treehouseId}/profiles/myProfile")
@Operation(summary = "λ‚΄ ν”„λ‘œν•„ μˆ˜μ • \uD83D\uDC64 βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ λ‚΄ ν”„λ‘œν•„μ„ μˆ˜μ •ν•©λ‹ˆλ‹€.")
@Operation(summary = "λ‚΄ ν”„λ‘œν•„ μˆ˜μ • \uD83D\uDC64 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ λ‚΄ ν”„λ‘œν•„μ„ μˆ˜μ •ν•©λ‹ˆλ‹€.")
public CommonResponse<MemberResponseDTO.updateProfile> updateProfile(
@PathVariable final Long treehouseId,
@RequestBody final MemberRequestDTO.updateProfile request,
Expand All @@ -66,7 +66,7 @@ public CommonResponse<MemberResponseDTO.updateProfile> updateProfile(
}

@GetMapping("/treehouses/{treehouseId}/profiles/{memberId}/posts")
@Operation(summary = "멀버가 μž‘μ„±ν•œ κ²Œμ‹œκΈ€ 쑰회 \uD83D\uDC64 βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ νŠΉμ • 멀버가 μž‘μ„±ν•œ κ²Œμ‹œκΈ€ λͺ©λ‘μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "멀버가 μž‘μ„±ν•œ κ²Œμ‹œκΈ€ 쑰회 \uD83D\uDC64 πŸ”‘ βœ…", description = "νŠΉμ • νŠΈλ¦¬ν•˜μš°μŠ€μ—μ„œ νŠΉμ • 멀버가 μž‘μ„±ν•œ κ²Œμ‹œκΈ€ λͺ©λ‘μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<PostResponseDTO.getMemberPostList> getPosts(
@PathVariable(name = "treehouseId") Long treehouseId,
@PathVariable(name = "memberId") Long memberId,
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/treehouse/server/api/notification/presentation/NotificationApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class NotificationApi {
private final NotificationService notificationService;

@GetMapping("/users/notifications")
@Operation(summary = "μ•Œλ¦Ό 쑰회 \uD83D\uDD11βœ…", description = "μ‚¬μš©μžμ˜ μ•Œλ¦Όμ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "μ•Œλ¦Ό 쑰회 \uD83D\uDD11πŸ”‘ βœ…", description = "μ‚¬μš©μžμ˜ μ•Œλ¦Όμ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<NotificationResponseDTO.getNotifications> getNotifications(
@AuthMember @Parameter(hidden = true) User user
){
Expand Down
16 changes: 8 additions & 8 deletions src/main/java/treehouse/server/api/post/presentation/PostApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public class PostApi {
private final PostService postService;

@GetMapping("/posts/{postId}")
@Operation(summary = "κ²Œμ‹œκΈ€ μƒμ„Έμ‘°νšŒ \uD83D\uDD11βœ…, πŸ”‘", description = "νŠΉμ • κ²Œμ‹œκΈ€μ˜ 상세정보λ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "κ²Œμ‹œκΈ€ μƒμ„Έμ‘°νšŒ \uD83D\uDD11πŸ”‘ βœ…", description = "νŠΉμ • κ²Œμ‹œκΈ€μ˜ 상세정보λ₯Ό μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<PostResponseDTO.getPostDetails> getPostDetails(
@PathVariable Long treehouseId,
@PathVariable Long postId,
Expand All @@ -38,7 +38,7 @@ public CommonResponse<PostResponseDTO.getPostDetails> getPostDetails(
}

@PostMapping("/posts")
@Operation(summary = "κ²Œμ‹œκΈ€ μž‘μ„± \uD83D\uDD11βœ… πŸ”‘", description = "κ²Œμ‹œκΈ€ μž‘μ„± API μž…λ‹ˆλ‹€.")
@Operation(summary = "κ²Œμ‹œκΈ€ μž‘μ„± \uD83D\uDD11πŸ”‘ βœ…", description = "κ²Œμ‹œκΈ€ μž‘μ„± API μž…λ‹ˆλ‹€.")
public CommonResponse<PostResponseDTO.createPostResult> createPost(
@PathVariable(name = "treehouseId") Long treehouseId,
@RequestBody @Valid PostRequestDTO.createPost request,
Expand All @@ -48,7 +48,7 @@ public CommonResponse<PostResponseDTO.createPostResult> createPost(
}

@PostMapping("/posts/images")
@Operation(summary = "presigned Url λ°œκΈ‰ API \uD83D\uDD11βœ… πŸ”‘", description = "사진 μ—…λ‘œλ“œλ₯Ό μœ„ν•œ presigned Url을 λ°œκΈ‰λ°›λŠ” API μž…λ‹ˆλ‹€.")
@Operation(summary = "presigned Url λ°œκΈ‰ API \uD83D\uDD11πŸ”‘ βœ…", description = "사진 μ—…λ‘œλ“œλ₯Ό μœ„ν•œ presigned Url을 λ°œκΈ‰λ°›λŠ” API μž…λ‹ˆλ‹€.")
public CommonResponse<PostResponseDTO.createPresignedUrlResult> createPresignedUrl(
@PathVariable(name = "treehouseId") Long treehouseId,
@RequestBody @Valid PostRequestDTO.uploadFile request,
Expand All @@ -58,7 +58,7 @@ public CommonResponse<PostResponseDTO.createPresignedUrlResult> createPresignedU
return CommonResponse.onSuccess(postService.createPresignedUrl(request));
}
@GetMapping
@Operation(summary = "κ²Œμ‹œκΈ€ λͺ©λ‘ 쑰회 πŸ”‘", description = "νŠΈλ¦¬ν•˜μš°μŠ€μ˜ κ²Œμ‹œκΈ€ λͺ©λ‘μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
@Operation(summary = "κ²Œμ‹œκΈ€ λͺ©λ‘ 쑰회 πŸ”‘ βœ…", description = "νŠΈλ¦¬ν•˜μš°μŠ€μ˜ κ²Œμ‹œκΈ€ λͺ©λ‘μ„ μ‘°νšŒν•©λ‹ˆλ‹€.")
public CommonResponse<List<PostResponseDTO.getPostDetails>> getPosts(
@PathVariable Long treehouseId,
@RequestParam(defaultValue = "0") int page,
Expand All @@ -68,7 +68,7 @@ public CommonResponse<List<PostResponseDTO.getPostDetails>> getPosts(
}

@PatchMapping("/posts/{postId}")
@Operation(summary = "κ²Œμ‹œκΈ€ μˆ˜μ • βœ… πŸ”‘", description = "κ²Œμ‹œκΈ€μ„ μˆ˜μ •ν•©λ‹ˆλ‹€(μ΄λ―Έμ§€λŠ” μˆ˜μ •λΆˆκ°€)")
@Operation(summary = "κ²Œμ‹œκΈ€ μˆ˜μ • πŸ”‘ βœ…", description = "κ²Œμ‹œκΈ€μ„ μˆ˜μ •ν•©λ‹ˆλ‹€(μ΄λ―Έμ§€λŠ” μˆ˜μ •λΆˆκ°€)")
public CommonResponse<PostResponseDTO.updatePostResult> updatePost(
@PathVariable Long treehouseId,
@PathVariable Long postId,
Expand All @@ -79,7 +79,7 @@ public CommonResponse<PostResponseDTO.updatePostResult> updatePost(
}

@DeleteMapping("/posts/{postId}")
@Operation(summary = "κ²Œμ‹œκΈ€ μ‚­μ œ βœ… πŸ”‘", description = "κ²Œμ‹œκΈ€μ„ μ‚­μ œν•©λ‹ˆλ‹€.")
@Operation(summary = "κ²Œμ‹œκΈ€ μ‚­μ œ πŸ”‘ βœ…", description = "κ²Œμ‹œκΈ€μ„ μ‚­μ œν•©λ‹ˆλ‹€.")
public CommonResponse deletePost(
@PathVariable Long treehouseId,
@PathVariable Long postId,
Expand All @@ -91,7 +91,7 @@ public CommonResponse deletePost(


@PostMapping("/posts/{postId}/reports")
@Operation(summary = "κ²Œμ‹œκΈ€ μ‹ κ³  βœ… πŸ”‘", description = "κ²Œμ‹œκΈ€μ„ μ‹ κ³ ν•©λ‹ˆλ‹€.")
@Operation(summary = "κ²Œμ‹œκΈ€ μ‹ κ³  πŸ”‘ βœ…", description = "κ²Œμ‹œκΈ€μ„ μ‹ κ³ ν•©λ‹ˆλ‹€.")
public CommonResponse reportPost(
@PathVariable(name = "treehouseId") Long treehouseId,
@PathVariable(name = "postId") Long postId,
Expand All @@ -103,7 +103,7 @@ public CommonResponse reportPost(
}

@PostMapping("/posts/{postId}/reactions")
@Operation(summary = "κ²Œμ‹œκΈ€ λ°˜μ‘ βœ… πŸ”‘", description = "κ²Œμ‹œκΈ€μ— κ°μ •ν‘œν˜„μ„ λ‚¨κΉλ‹ˆλ‹€.")
@Operation(summary = "κ²Œμ‹œκΈ€ λ°˜μ‘ πŸ”‘ βœ…", description = "κ²Œμ‹œκΈ€μ— κ°μ •ν‘œν˜„μ„ λ‚¨κΉλ‹ˆλ‹€.")
public CommonResponse<String> reactToPost(
@PathVariable(name = "treehouseId") Long treehouseId,
@PathVariable(name = "postId") Long postId,
Expand Down
Loading