팀 코드 작성 규칙
명명 규칙
- PR올리기 전에 코드 정렬하기 / 안쓰는 import 제거
- 변수명
- 카멜케이스
- Collection 변수는
변수명
+ Collection 타입
- ex. List<Card> cardList (cards X)
- 테이블명 단수로 해주기
- API URI는 복수형
로직 작성 규칙
- 각 메서드마다 기능설명 주석 달아주기
- Primary Key, Foreign Key는 언더바 쓰지 않기(FK는 카멜케이스로 해도 DB에서 snake로 고쳐줍니다.)
- Swagger 적용하기
@Tag(name = "User API", description = "User API 정보를 담고 있습니다.")
: controller 위에 달기
@Operation(summary = "User 회원가입", description = "회원가입을 합니다.")
: method 위에 달기
- ServiceImpl 만들고 주석으로 메서드 위에 param return 작성해주기.
- QueryDsl 적용(2개로 정은님이 보고 수정해주세요)
- 서비스 단 로직 구현할 때 서비스에 관계된 레포지토리만 가져오고 그 외의 것이 필요하면 레포지토리가 아니라 서비스단으로 가져올 것
- CustomException 적용
- Entity에
@Builder
/ 생성자 두 개 다.. 쓰기
- ApiResponseDto 적용하기(일단 만들어두기)
- ResponseEntity<Dto> 형식으로 메서드 return해주기
그 외