Merge pull request #39 from prgrms-web-devcourse-final-project/feature/EA3-99-member-api

[EA3-99] 회원 관련 swagger 구현

Author: endorsement0912

src/main/java/grep/neogul_coder/domain/prtemplate/entity/PrTemplate.java

@@ -9,14 +9,14 @@ public class PrTemplate extends BaseEntity {
 
     @Id
     @GeneratedValue(strategy = GenerationType.AUTO)
-    Long templateId;
+    private Long templateId;
 
-    Long userId;
+    private Long userId;
 
-    String introductionContent;
+    private String introductionContent;
 
-    String introductionDetail;
+    private String introductionDetail;
 
-    String location;
+    private String location;
 
 }

src/main/java/grep/neogul_coder/domain/users/controller/UserController.java

@@ -1,29 +1,57 @@
 package grep.neogul_coder.domain.users.controller;
 
+import grep.neogul_coder.domain.users.controller.dto.UpdatePasswordRequest;
+import grep.neogul_coder.domain.users.controller.dto.UpdateProfileRequest;
+import grep.neogul_coder.domain.users.controller.dto.PasswordRequest;
 import grep.neogul_coder.global.response.ApiResponse;
 import grep.neogul_coder.domain.users.controller.dto.SignUpRequest;
 import grep.neogul_coder.domain.users.service.UserService;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.DeleteMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/users")
-public class UserController {
+public class UserController implements UserSpecification {
 
     private final UserService usersService;
 
     @PostMapping("/signup")
     @ResponseStatus(HttpStatus.CREATED)
     public ApiResponse<Void> signUp(@Valid @RequestBody SignUpRequest request) {
         usersService.signUp(request);
-        return ApiResponse.noContent("회원가입이 정상적으로 처리되었습니다.");
+        return ApiResponse.noContent();
+    }
+
+    @PutMapping("/{id}")
+    public ApiResponse<Void> updateProfile(@PathVariable("id") Long id,
+        @RequestBody UpdateProfileRequest request) {
+        usersService.updateProfile(id,request.getNickname(),request.getProfileImgUrl());
+        return ApiResponse.noContent();
+    }
+
+    @PutMapping("/password/{id}")
+    public ApiResponse<Void> updatePassword(@PathVariable("id") Long id,
+        @Valid @RequestBody UpdatePasswordRequest request) {
+        usersService.updatePassword(id,request.getPassword(),request.getNewPassword(),request.getNewPasswordCheck());
+        return ApiResponse.noContent();
+    }
+
+    @DeleteMapping("/{id}")
+    public ApiResponse<Void> delete(@PathVariable("id") Long id,
+        @Valid @RequestParam PasswordRequest request) {
+        usersService.deleteUser(id,request.getPassword());
+        return ApiResponse.noContent();
     }
 
 }

src/main/java/grep/neogul_coder/domain/users/controller/UserSpecification.java

@@ -1,14 +1,27 @@
 package grep.neogul_coder.domain.users.controller;
 
+import grep.neogul_coder.domain.users.controller.dto.PasswordRequest;
 import grep.neogul_coder.domain.users.controller.dto.SignUpRequest;
+import grep.neogul_coder.domain.users.controller.dto.UpdatePasswordRequest;
+import grep.neogul_coder.domain.users.controller.dto.UpdateProfileRequest;
 import grep.neogul_coder.global.response.ApiResponse;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import org.springframework.web.bind.annotation.PathVariable;
 
 @Tag(name = "User", description = "회원 API")
 public interface UserSpecification {
 
     @Operation(summary = "회원 가입", description = "회원 정보를 저장합니다.")
-    ApiResponse<Void> signUp(SignUpRequest request);
+    ApiResponse<Void> signUp(@RequestBody SignUpRequest request);
 
+    @Operation(summary = "회원 프로필 수정", description = "회원 프로필을 수정합니다.")
+    ApiResponse<Void> updateProfile(@PathVariable Long id,@RequestBody UpdateProfileRequest request);
+
+    @Operation(summary = "회원 비밀번호 수정", description = "회원 비밀번호를 수정합니다.")
+    ApiResponse<Void> updatePassword(@PathVariable Long id, @RequestBody UpdatePasswordRequest request);
+
+    @Operation(summary = "회원 상태 삭제로 변경", description = "회원 상태를 삭제로 변경합니다.")
+    ApiResponse<Void> delete(@PathVariable Long id, @RequestBody PasswordRequest request);
 }

src/main/java/grep/neogul_coder/domain/users/controller/dto/PasswordRequest.java

@@ -0,0 +1,12 @@
+package grep.neogul_coder.domain.users.controller.dto;
+
+import jakarta.validation.constraints.NotBlank;
+import lombok.Data;
+
+@Data
+public class PasswordRequest {
+
+    @NotBlank(message = "비밀번호를 입력하세요")
+    String password;
+
+}

src/main/java/grep/neogul_coder/domain/users/controller/dto/SignUpRequest.java

@@ -7,23 +7,25 @@
 import lombok.Data;
 
 @Data
+@Schema(description = "회원가입")
 public class SignUpRequest {
 
     @NotBlank(message = "이메일을 입력해주세요.")
     @Email
-    @Schema(example = "[email protected]")
+    @Schema(description = "이메일", example = "[email protected]")
     private String email;
 
     @NotBlank(message = "비밀번호를 입력해주세요")
+    @Schema(description = "비밀번호", example = "example123")
     private String password;
 
     @NotBlank(message = "비밀번호 확인을 입력해주세요.")
-    @Schema(description = "비밀번호 확인")
+    @Schema(description = "비밀번호 확인", example = "example123")
     private String passwordCheck;
 
     @NotBlank(message = "닉네임은 필수 입력 사항입니다.")
-    @Size(min = 2, max = 8, message = "닉네임은 최소 2자, 최대 10자까지 입력 가능합니다.")
-    @Schema(example = "홍길동")
+    @Size(min = 2, max = 10, message = "닉네임은 최소 2자, 최대 10자까지 입력 가능합니다.")
+    @Schema(description = "닉네임", example = "홍길동")
     private String nickname;
 
-}
+}

src/main/java/grep/neogul_coder/domain/users/controller/dto/UpdatePasswordRequest.java

@@ -0,0 +1,23 @@
+package grep.neogul_coder.domain.users.controller.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import jakarta.validation.constraints.NotBlank;
+import lombok.Data;
+
+@Data
+@Schema(description = "비밀번호 변경")
+public class UpdatePasswordRequest {
+
+    @NotBlank(message = "현재 비밀번호를 입력해주세요")
+    @Schema(description = "현재 비밀번호", example = "oldPassword")
+    String password;
+
+    @NotBlank(message = "변겯할 비밀번호를 입력해주세요")
+    @Schema(description = "새 비밀번호", example = "newPassword")
+    String newPassword;
+
+    @NotBlank(message = "비밀번호 확인을 입력해주세요")
+    @Schema(description = "새 비밀번호 확인", example = "newPassword")
+    String newPasswordCheck;
+
+}

src/main/java/grep/neogul_coder/domain/users/controller/dto/UpdateProfileRequest.java

@@ -0,0 +1,16 @@
+package grep.neogul_coder.domain.users.controller.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Data;
+
+@Data
+@Schema(description = "유저 프로필 변경")
+public class UpdateProfileRequest {
+
+    @Schema(description = "닉네임", example = "example")
+    String nickname;
+
+    @Schema(description = "프로필 이미지")
+    String profileImgUrl;
+
+}

src/main/java/grep/neogul_coder/domain/users/entity/User.java

@@ -8,42 +8,63 @@
 import jakarta.persistence.GeneratedValue;
 import jakarta.persistence.GenerationType;
 import jakarta.persistence.Id;
+import jakarta.persistence.Table;
 import jakarta.validation.constraints.Email;
-import jakarta.validation.constraints.NotBlank;
 import lombok.Builder;
 import lombok.Getter;
 
 @Entity
 @Getter
-@Builder
+@Table(name = "member")
 public class User extends BaseEntity {
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
-    Long id;
+    private Long id;
 
-    String oauthId;
+    private String oauthId;
 
-    String oauthProvider;
+    private String oauthProvider;
 
-    @NotBlank
     @Email
-    String email;
+    private String email;
 
-    @NotBlank
-    String password;
+    private String password;
 
-    @NotBlank
-    String nickname;
+    private String nickname;
 
-    String profileImageUrl;
+    private String profileImageUrl;
 
     @Enumerated(EnumType.STRING)
-    Role role;
+    private Role role;
 
-    Boolean isDeleted;
+    private Boolean isDeleted;
 
-    protected User(Long id, String oauthId, String oauthProvider, String email, String password,
+    public static User UserInit(String email, String password, String nickname) {
+        return User.builder()
+            .email(email)
+            .password(password)
+            .nickname(nickname)
+            .isDeleted(false)
+            .role(Role.ROLE_USER)
+            .build();
+    }
+
+    public void updateProfile(String nickname, String profileImageUrl) {
+        this.nickname = nickname;
+        this.profileImageUrl = profileImageUrl;
+    }
+
+    public void updatePassword(String password) {
+        this.password = password;
+    }
+
+    public void delete() {
+        this.isDeleted = true;
+    }
+
+    @Builder
+    private User(Long id, String oauthId, String oauthProvider, String email, String password,
         String nickname, String profileImageUrl, Role role, Boolean isDeleted) {
         this.id = id;
         this.oauthId = oauthId;
@@ -58,14 +79,4 @@ protected User(Long id, String oauthId, String oauthProvider, String email, Stri
 
     protected User() {
     }
-
-    public static User UserInit(String email, String password, String nickname) {
-        return User.builder()
-            .email(email)
-            .password(password)
-            .nickname(nickname)
-            .isDeleted(false)
-            .role(Role.ROLE_USER)
-            .build();
-    }
 }

src/main/java/grep/neogul_coder/domain/users/repository/UserRepository.java

@@ -1,11 +1,16 @@
 package grep.neogul_coder.domain.users.repository;
 
 import grep.neogul_coder.domain.users.entity.User;
+import jakarta.validation.constraints.NotBlank;
 import java.util.Optional;
 import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.jpa.repository.Modifying;
+import org.springframework.data.jpa.repository.Query;
 import org.springframework.stereotype.Repository;
 
 @Repository
 public interface UserRepository extends JpaRepository<User, Long> {
     Optional<User> findByEmail(String email);
+    Optional<User> findByNickname(String nickname);
+
 }