2024. 07. 27(Sat)

📋 의논 주제

1. API 문서를 생성하는 테스트 클래스 별도 생성 여부 ex) XXXControllerDocsTest
2. 동적 쿼리 작성 도구 선정(JPQL, QueryDSL, MyBatis, ...)
3. 커스터마이징 해놓은 공통 리스폰스 클래스인 ApiResponse 사용
4. API 문서를 작성하는 코드에 데이터의 타입 명시

🗣️ 논의 사항

1. API 문서를 생성하는 테스트 클래스 별도 생성 여부

• 결론: API 문서를 생성하는 테스트 클래스는 ~ControllerDocsTest로 나눠서 따로 작성한다.

2. 동적 쿼리 작성 도구 선정

• 결론: 동적 쿼리 도구는 프로젝트 초기에 기술 스택을 논의할 때 결정했었던 QueryDSL을 그대로 사용한다.

3. 커스터마이징 해놓은 공통 리스폰스 클래스인 ApiResponse 사용

• 결론: 프론트엔드 팀에서 성공 흐름에서 응답을 보낼 때 응답 페이로드 본문에 상태 코드나 메시지는 필요하지 않다고 해서 제외한다.

4. API 문서를 작성하는 코드에 데이터의 타입 명시

• 결론: REST Docs에서 같이 넘어가는 데이터의 타입을 명시한다.