인프런 커뮤니티 질문&답변

김주원님의 프로필 이미지

작성한 질문수

[코드캠프] 부트캠프에서 만든 고농축 백엔드 코스

10-03 상품 등록, 조회 API

폴더, 파일, 함수 생성시 s붙이는 기준

해결된 질문

작성

·

199

·

수정됨

0

product vs products 와 같이

파일 및 폴더 생성시 s를 붙이는 기준이

좀 해깔리는데,

어디에서 설명해주셨는지 기억이 안나서

질문 드립니다~

답변 주시면 감사하겠습니다~

1.apis 아래 1depth 폴더에는 s를 붙임

apis/products

 

2. entities 폴더 내부 파일 s 안붙임

entities/product.entity.ts

 

3.module.ts, resolver.ts, service.ts 에는 s붙임

src/products/products.module.ts

src/products/products.resolver.ts

src/products/products.service.ts

 

 

답변 2

1

김주원님의 프로필 이미지
김주원
질문자

자세한 답변 감사합니다~

1

노원두님의 프로필 이미지
노원두
지식공유자

안녕하세요! 주원님!

사실 폴더명의 경우, 회사마다 너무나도 다르기 때문에 어떠한 방식을 사용하시더라도 내부 개발팀과 커뮤니케이션에 문제가 없으면 괜찮습니다!

 

수업에서는, 수강생분들과 모두 규칙을 통일하고자 우리만의 룰을 만들었던 것이었어요!^^
다만, 룰이 너무 제멋대로이면 복잡하고 어려울 수 있으니, 가장 쉬운 방법으로 공신력 있는 공식문서에 나와있는 폴더구조를 따르자 라는 것 뿐이었습니다!^^

 

공식문서 및 공식문서기반 예제코드내 폴더구조는 아래와 같네요!^^

2개 이상으로 여러개면 폴더에 s 붙이기 (단, 셀수없는 이름에는 안붙이기 => Auth, Jwt 등)

1. API 폴더들
products // 셀수있음
users // 셀수있음
auth // 셀수없음
...

2-1. entitiy가 여러개라면?
products/entities/product1.entity.ts
products/entities/product2.entity.ts

2-2. entity가 1개라면?
products/product.entity.ts


3. module.ts, resolver.ts, service.ts 등
src/products/products.module.ts
src/products/products.resolver.ts
src/products/products.service.ts

 

다시 한 번 말씀드리지만, 공식문서를 기준으로 우리만의 규칙을 만든 것 뿐이에요!
s의 존재유무를 매번 고려해야하기 때문에, 많은 회사들이 그룹단위(products, users) 들은 그냥 고유명사로 치는 경우도 많습니다! => product, user, auth, payment, ...