스파르타 코딩클럽
내일배움캠프 AI 웹개발자양성과정 2회차
2022.05.04. 13일차- TIL
1. API 문서 작성 논의
09:00-12:00 API 문서 작성 논의
12:00-13:00 DB 설계
어제 프로젝트 기획에 이어서 오늘은 각자 맡은 부분에 대한 API 문서 작성을 시작했다. 먼저 다같이 API 문서에 대해 논의해보고 왜 작성해야하는지, 어떻게 작성해야하는지 충분한 이야기를 나눴다. API 작성에서 가장 중요한 것은 프론트엔드 개발자가 알아 볼 수 있도록 작성하는 것이라고 생각했다.
이후에는 이상록 튜터님과 피드백 시간을 가졌는데 DB설계에 있어서 한가지 수정할 점을 짚어주셨다. 바로 팔로우, 팔로잉에 대한 정보를 user DB가 가지고 있으면 안된다는 것. 팔로우 팔로잉 수가 많아질 수록 user하나의 데이터가 커지게되고 과부하가 걸릴 수 있다는 것이다. 따라서 해당 부분의 콜랙션을 따로 만들어서 user key로 접근할 수 있도록 DB를 수정했다. 이 부분은 다른 프로젝트를 진행하면서도 궁금했던 점이었는데 확실하게 짚고 넘어갈 수 있어서 너무 좋았다.
2. API 문서 작성
13:00-14:00 점심시간
14:00-18:00 API 문서 작성
18:00-19:00 DB 데이터 명세
오후에는 본격적으로 자신이 맡은 기능에대한 API 문서를 작성하였다. 나는 메이킹챌린지를 통해 프로젝트를 진행하면서 API 문서를 작성해본 경험이 있어서 다른 팀원들은 처음이었지만 내가 많이 도와줄 수 있었다. 물론 나도 팀원들이 작성한 API 문서를 보면서 배울 점도 많이 있었다. 특히 requests parameter로 유저 정보를 보낼 때 객체로 보내는 것이 적절하지 않다고 느꼈는데 팀원이 작성한 API 문서를 보면서 객체가 아니라객체의 구성요소를 parameter로 보내면 간단하다는 것을 알 수 있었다. 다만 한가지 아쉬운 것은 작성하기전 변수명을 어떻게 정할지에 대한 가이드를 정하지않아 각자의 API 문서를 모두 합쳤을 때 통일감이 느껴지지않았고 변수명을 다시 통일 시켜주는 작업을 추가로 해야했다. 다음부터는 변수명을 작성하는 방법이나 함수명 등등 개발에 들어가기에 앞서 많은 부분을 논의해야겠다.
이후에는 설계해놨던 DB의 세부 데이터 정보를 표로 정리해보았다. 미리 DB설계에 있어서 충분한 논의를 거쳐서그런지 쉽게 할 수 있었다.
- Posts 콜렉션의 데이터 정보
3. 앞으로의 일정
19:00-20:00 저녁시간
20:00-21:00 일일회고 및 TIL 작성
지금까지 우리 팀이 프로젝트에서 무엇을 개발한 것인지에 대해 기술했다면 내일부터는 그 기술한 내용들을 본격적으로 개발할 것이다. 물론 개발을 하다가보면 중간중간에 막히는 부분도 있고 수정해야하는 부분도 많을 것이다. 하지만 주먹구구식으로 개발을 하는 것보다 팀원들과 서로 소통하고 어떻게하면 더 좋은 설계를 할 수 있을지 고민해보는 것은 정말 좋은 경험이었다고 생각한다.
4. 프로젝트 정보
1) github
https://github.com/ai-web-9-team/59stargram
2) notion workspace
https://www.notion.so/kimphysicsman/7db33adca12b403a8a19df5ccce01b70
