[TIL] API! API! API!

조성현·2022년 11월 1일
0

API 문서가 왜 중요한지 알게 된 하루였다.

오늘은 팀원들이 각자 작성한 프론트엔드 / 백엔드 문서들을 합쳐 미니프로젝트를 구현하는 날이었다.
프론트엔드 문서를 받았을 때 코드를 보고 기절하는 줄 알았다..

끝없이 펼쳐지는 </div>의 향연에 기절할 뻔 했지만.. 정신을 부여잡고 디버깅에 늪으로 다이빙을 시작했다...

Flask와 MongoDB를 활용해
댓글작성> POST > DB에 저장 > GET > 화면에 출력 하는 과정은 어렵지 않았지만 문제는 역시 '이걸 어떻게 html에 붙이는가'였다.

코드를 하나하나 읽어보기엔 너무 어지러워서 일단 개발자도구를 활용해 구조를 파악하고, 하나 하나 붙여나가는 방식으로 겨우겨우 연동하는데 성공했다.

이 모든 과정을 거치며 프로젝트가 시작할 때 왜! S.A 문서부터 작성해야하고, 그 중에서도 API문서를 작성해야하는지를 깨달았다.


API문서를 처음 작성할 때는 일단 비슷


Today I Learned

1. 디버깅

강의를 들으며 클론코딩 할 때와는 다른 느낌이었다.
왜 안되지?에서 출발해 코드들을 역순으로 타고 올라가며 오류를 수정하는 법을 습득했다.
코드를 하나하나 역순으로 읽어보면서 오류를 수정해나가는 과정을 통해 작동원리에 대한 고민과 배움을 얻을 수 있었다.

ps. 왜 개발자들이 허리와 목 디스크를 달고 사는지 이해하게 됐다... 뭔가 가까이서 보면 더 잘 보이는 느낌..? 때문에 자꾸만 모니터와 가까워진다.

2. 협업의 꽃은 이름짓기임을 배웠다

사실 지금은 변수명들이 직관적이지 못해 아쉬움이 크다.
이미 html, js, css 사이에서 잔뜩 엉켜있는 상태라 건들지 못했지만, 기본적인 기능 구현을 완료한 뒤에 팀원들과 함께 리팩터링을 진행하며 직관적인 변수명을 설정해야겠다...

profile
맛있는 음식과 여행을 좋아하는 당당한 뚱땡이

3개의 댓글

comment-user-thumbnail
2022년 11월 9일

API = A(아프고) P(피나고) I(인상찌푸리게되는)
안녕하세요, 2023년 코딩의 신 지망생입니다. TIL구경 왔습니다 ~ ヽ(・̑ᴗ・̑)ノ

2개의 답글