백엔드 기능별로 api를 어떻게 작성하면 좋을지와 폴더를 어떻게 나눠야할지 조언 부탁드립니다 !

Question

Nest.js 공부하면서 간단한 CRUD 기능을 구현해보고 있는데 기능별로 폴더를 어떻게 나누면 좋을지 고수님들의 조언을 받아보고 싶습니다!저는 일정 - 일정 세부사항 - 일정 체크리스트 이렇게 3개로 세분화해서 만들어보려고 합니다일정전체 일정 불러오기 GET /schedule일정 생성하기 POST /schedule 특정 일정 불러오기, 수정, 삭제하기 GET, PUT, DELETE /schedule/:schedule_id일정 세부사항일정 세부사항 관련 /schedule/detail/:schedule_id일정 체크리스트일정 체크리스트 관련 /schedule/checklist/:schedule_id이렇게 만들어보고 있는데.. 완전 입문자인지라 api 명세를 저렇게 작성해도 되는지 잘 모르겠기도 하고(schedule_id를 param으로 전달하는게 나을지, body로 전달하는게 나을지도 궁금합니다.), 폴더를 나눈다면 schedule 폴더에 저 기능들을 다 넣어주는게 좋을지, schedule/detail/checklist 폴더에 각각 넣어주는게 좋을지 잘 모르겠습니다. (entitiy는 schedule, detail, checklist를 분리했습니다.) 고수님들의 조언 부탁드립니다 ...!!

둘둘넷넷 · Answer

일정 세부사항이 schedule_id면 특정 개개인의 세부사항인가요? 그럼 body에 넣는게 좋아보입니다.나머지는 개인 취향이라 어떻게 정리하느냐에 따라 달라질것처럼 보입니다. 대메뉴 -> 소메뉴 타는식으로 폴더 나눠서 정리하시면 다른사람이 봤을 때도 편하게 볼 수 있을것 같긴 합니다.

kenu,전독시 · Answer

명확하고 일관된 API 디자인을 위한 가이드https://medium.com/tech-pentasecurity/restful-api-%EB%84%A4%EC%9D%B4%EB%B0%8D-7c81bdb9da63이 링크 참고해 보세요.

백엔드 기능별로 api를 어떻게 작성하면 좋을지와 폴더를 어떻게 나눠야할지 조언 부탁드립니다 !

2개의 답변

#nest.js 목록