Skip to content

Commit

Permalink
Merge pull request #81 from Team-Shaka/feat/79
Browse files Browse the repository at this point in the history 
📝 Docs: API 명세 보완
  • Loading branch information
@HyoBN
HyoBN authored Jul 10, 2024
2 parents 2baa924 + 75653e6 commit d76c526
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 deletions.
10 changes: 5 additions & 5 deletions src/main/java/treehouse/server/api/comment/presentation/CommentApi.java
View file
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
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
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
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

0 comments on commit d76c526

Please sign in to comment.