프로젝트 기간
: 2022.11.28 ~ 2023.3.9 (약 2달)
개인 프로젝트
주제:
API 설계를 공부하고 문서화 과정을 경험한 개인 프로젝트.
목표:
테스트 기반으로 문서화 작업을 자동으로 진행하는 Spring Rest Docs 문서 작성 과정을 경험해보고 API 개발 프로세스에 대해 이해하기
진행 프로세스:
- RESTful 설계란 무엇이고, 무엇을 지키며 개발해야 하는지 공부.
- 테스트 코드를 짜며 진행하며 문서화를 어떻게 시키는지 과정에 대해서 이해.
- 효율적인 예외 처리 구조에 대해 배우고 생각해볼 수 있는 계기.
문제 해결과정:
- 회원 인증과 관련된 예외부터 시작해서 글 조회 실패까지 많은 예외 처리를 어떤 방식으로 관리해야 할까 고민.
- 최상위 커스텀 추상 클래스를 하나 두고, 이를 상속하는 방식으로 설계하여 ControllerAdvice 에서 한 번에 잡는 구조에 대해 배움.
- 글 조회 과정에서 QueryDSL 과 페이징에 대해서도 적용해보며 기술적인 부분을 많이 배울 수 있었음.
결론:
API 개발은 지금까지 해오던 개발과 어떤 점이 다른지 호기심에 시작했던 프로젝트였는데, 생각보다 구조적으로 또 기술적으로
배운 부분이 많아 진행해보기 매우 잘했다고 생각한다.