Feat [#10] 이력서 등록 POST API 구현

[chaentopia]

🍀 작업한 내용에 대해 설명해주세요

• Service는 다음과 같이 에러처리 했습니다!
  

  Jumpit-SERVER/jumpit/src/main/java/org/sopt/jumpit/resume/service/ResumeService.java

  Lines 20 to 29 in bc4f323

  	@Transactional
  	public void createResume(
  	ResumeCreateRequest resumeCreateRequest
  	) {
  	User findUser = userRepository.findById(resumeCreateRequest.userId()).orElseThrow(
  	() -> new BusinessException(ErrorMessage.USER_NOT_FOUND_BY_ID_EXCEPTION)
  	);
  	Resume resume = Resume.create(findUser, resumeCreateRequest.title());
  	resumeRepository.save(resume);
  	}

• 디폴트로 비공개 여부 false값을 받기 때문에 추가했습니다.
  

  Jumpit-SERVER/jumpit/src/main/java/org/sopt/jumpit/resume/domain/Resume.java

  Lines 33 to 38 in bc4f323

  	@Builder
  	private Resume(User owner, String title) {
  	this.owner = owner;
  	this.title = title;
  	this.isPrivate = false;
  	}

• Controller입니다!
  

  Jumpit-SERVER/jumpit/src/main/java/org/sopt/jumpit/resume/controller/ResumeController.java

  Lines 23 to 30 in bc4f323

  	@PostMapping
  	public ResponseEntity<SuccessResponse> createResume (
  	@RequestBody ResumeCreateRequest resumeCreateRequest
  	) {
  	resumeService.createResume(resumeCreateRequest);
  	return ResponseEntity.ok()
  	.build();
  	}

🍀 어떤 것을 중점으로 리뷰 해주길 바라시나요?

• 에러 처리 부분에서 이정도로 해도 괜찮은지..!

🍀 공통 작업 부분에 대한 수정 사항이 있다면 적어주세요

• 에러 메세지 추가

🍀 PR 유형

어떤 변경 사항인가요?

• 새로운 기능 추가
• 버그 수정
• 코드에 영향을 주지 않는 변경사항 (오타 수정, 탭 사이즈 변경, 변수명 변경)
• 코드 리팩토링
• 주석 추가 및 수정
• 문서 수정
• 파일 혹은 패키지명 수정
• 파일 혹은 패키지 삭제

🍀 Checklist

• 코드 컨벤션을 지켰나요?
• git 컨벤션을 지켰나요?
• PR 날리기 전에 검토하셨나요?

• 코드리뷰를 반영했나요?

🍀 Issue

Resolved #10

[geniusYoo]

전체적인 로직 구성은 잘하셨습니다 :) 가독성도 괜찮구요!

제가 체크한 몇가지 부분들은 다 코멘트로 남겨놓았으니, 적용해서 리팩토링하면 훨씬 깔끔한 코드가 될 것 같아요 !! 너무너무 고생하셨습니다 👍🏻👍🏻

모르겠는 부분은 언제든지 물어봐주세요 :) 화이팅!!!

[geniusYoo]

/api/v1은 Controller 레벨에다 두고 /resumes는 메소드 레벨로 낮추는 것이 좋을 것 같습니다 :))

[geniusYoo]

구체적으로 말씀드려보면,

@RequestMapping("/api/v1")
...
@PostMapping("/resumes")
public ResponseEntity<SuccessResponse> createResume

요렇게 수정해보면 어떨까요 :)!

[geniusYoo]

Controller를 잘 구성해주신 것 같은데요! 조금만 개선하면 더 좋은 코드가 될 것 같아요 :)

ResponseEntity<SuccessResponse>보다는 반환값이 void라면 ResponseEntity<SuccessResponse<Void>> 로 반환값을 명확하게 지정해주면 좋을 것 같구요 !

이력서를 생성하는 API이기 때문에 201 Created 를 반환해야 합니다 !
추가적으로, 201 Created는 Request Header에 생성된 이력서의 pk값(기본키, 여기서는 id 값이겠죠?) 을 담아서 응답해줘야 합니다!

이 두가지를 한번 리마인드 해보시면서 리팩토링 해주면 더 멋진 코드가 될 것 같아요 🙂

[jsoonworld]

저도 같은 생각입니다! 😊

[chaentopia]

궁금한 게 있는데 그렇게 되면 클라 단에서는 어차피 GET API를 사용해서 이력서 리스트를 받게 되는데 id 값을 반환해줘야 하는 이유를 알 수 있을까요!?
그리고 이렇게 바뀌게 되면 명세서의 Response 부분을 바꿔야 하는지도 궁금합니다!

[geniusYoo]

DB에 엔티티를 등록하는 API에서는 💡

RESTful API 설계 원칙에 따라, 새로운 리소스를 생성할 때는 201 Created 상태 코드와 함께 Location 헤더를 포함하는 것이 관례입니다! 이로써 API 사용자가 생성된 리소스의 위치를 쉽게 알 수 있도록 합니다 🙂

또한, 채은님의 질문처럼 명세서의 Response 부분이 수정되어야 하겠네요!
Response Body는 바뀌지 않지만, Header에 id값이 같이 전달된다는 것을 명시해야겠네요 :)
좋은 질문으로 한 단계 탄탄해지는 우리의 API 명세서 .,, 굿 ,,👍🏻

[geniusYoo]

Transactional 키워드 좋네요 :)!!

[geniusYoo]

Exception 처리를 적절하게 해주신 건 아주 좋은 포인트입니다!

하지만, BusinessException은 상위 Exception 클래스이기 때문에 NotFoundException 커스텀 클래스를 이용해 핸들링해주면 더 좋을 것 같아요 :)!

[geniusYoo]

Controller 에서 말씀드렸듯이, id 값을 같이 반환해주는 로직을 마지막 여기에 추가해주면 되겠죠 ? 😆🔥