https://docs.google.com/spreadsheets/d/1qU5aSahFpUHB7bceZACcmn0pbGGl_h81qdKtK8k5VvQ/edit?usp=sharing
이전에 엘리스트랙을 통해 처음으로 프로젝트를 진행하면서 api명세서를 작성했었다.
구글 스프레드시트를 통해 프론트,백엔드 모두에게 공유하고, 모두가 수정할 수 있도록 했다.
이번에 스터디로 프로젝트스터디를 하게 되면서, 2차프로젝트를 하기 전에 이전 프로젝트에서
아쉬웠던 부분들을 복기하는 느낌으로 하고 있는데, 같은 주제로 프로젝트를 맡았지만
모두 다른 팀에서 각자가 해왔다보니 방법이 조금씩 달랐다.
어느정도 많은 프로젝트와 업무를 경험했다면 바로 중요한 부분이 어느 부분인지 알텐데..
아무래도 처음 하나를 끝내고 이제 둘을 경험하다보니 차이의 간격을 좁히는 소통이 필요했다.
모두 같은 노션을 공유하고 있어서, api명세서를 간단하게 표로 작성해놓은 것이 있었는데,
프론트에서 자세하게 정리된 표를 원하셨다. 아마 그 정보들로는 작업하는데 필요한 무언가가
없었던 것 같다.
api명세서를 처음 만들어볼 때에는 가이드라인과 여러 포인트를 구글링하며 살펴보았는데,
어느정도 정형화된 표가 있긴 했지만 절대적인 기준이 있지는 않았다.
내 생각에는 서로 소통하는데 문제가 없어야 함이 중요하고, 한 눈에 이해할 수 있어야 한다.
한 프론트 팀원이 지난 프로젝트 때 포스트맨을 통해 api명세서를 작성한 ref를 주셔서
이를 참고하여 포스트맨을 통해 이번 api명세서를 작성해보았다.
https://documenter.getpostman.com/view/26758081/2s93kxd6qs#e48ec048-20de-4769-88c0-9fc32b93ccc7
이전 프로젝트에서는 백엔드가 나 포함 2명이였는데, 3일간 팀원이 부재해서 혼자 맡은 격에
다 알아서 해야 해서 막막했다. 결과보다는 배우는 것이 중요했기에 오히려 좋은 기회라고
생각했고, 덕분에 그 때 많은 항목들을 혼자 했던 것이 이번에 진행하면서 크게 도움이 되었다.
mvc를 고려하여 디렉토리를 설정하고, 4가지 정도의 항목을 mvc에 맞게 다 설정하는데
구조에 대한 이해부터 각 api를 연결하기 위해 혼자다보니 하루 종일 공부했던 것 같은데,
이번에는 3명인데 각 한두가지 항목만 맡았다보니 2시간정도만에 금방 만들어냈다.
포스트맨에서 테스트하면서 req,res가 다 나오는데 따로 복사해서 붙여넣기하기보다
save as example을 클릭하니 테스트한 그대로 결과값이 저장되었고,
view documentation을 통해 저장한 example을 그대로 공유할 수 있었다.
표로 작성해도 좋지만 이렇게 포스트맨에서 제공하는 방식으로 진행해도
crud에 맞게 각각 분류되어 있어서 그런지 확인하기 편했다.
현업에서 어떤 이슈들이 있을지 간접적으로나마 체험했던 것 같다.
git도 정말 처음에는 하나하나 건들기가 두렵고, 아직도 약간 두려움이 있기는 하지만,
기본적인 원리들이 이해가 되고 나서는 많이 속도도 빨라지고 편해졌다.
오히려 처음 배웠던 1차 프로젝트에 비해 작은 것들이다보니 복기하는데 있어 충분하고,
회의하면서 일이 커져서 당황했지만 많이 커지지 않아서 부담없이 해내고 있다.
무엇보다 협업이 즐겁다!^^
'개발 > 엘리스트랙 SW 4기' 카테고리의 다른 글
[엘리스트랙 SW 4기 | 2차 프로젝트] 프로젝트 시작하면서.. (0) | 2023.05.30 |
---|---|
[엘리스트랙 SW 4기 | 2차 스터디] ai를 이용한 사용자 감정에 맞는 그림 서비스 프로젝트 스터디 마무리 (0) | 2023.05.28 |
[엘리스트랙 SW 4기 | 2차 스터디] 2차 스터디.. 프로젝트로 결정! (0) | 2023.05.11 |
[엘리스트랙 SW 4기 | 1차 프로젝트] 진전이 보이지 않는 백엔드 프로젝트 (0) | 2023.04.21 |
[엘리스트랙 SW 4기 | 1차 프로젝트] 첫 프로젝트 진행중.. (0) | 2023.04.21 |