프론트에서 API 문서 작성을?! 백엔드를 위한 문서 작성해보기

사건의 발단

백엔드 팀원분께서 페이지별 API를 요청하셨다.

일단 나에게 API 문서라고는 이전에 진행한 첫 사이드 프로젝트에서 백엔드 선생님들이 보내주신 문서가 전부였기에 당연히 API 문서는 백엔드에서 전달해주는 것을 그대로 사용하는 것인 줄 알고 있었다. 역시 세상에 당연한 것은 없을지도 모르겠다.

함께 하고있는 프론트 팀원 분께선 프로젝트 경험이 다수 있으셨기에 작성 경험이 있으실까 싶어 여쭤봤지만, 프론트에서 API를 작성해서 전달했던 경험은 없다고 하셨다...! 😮

 

사실 저 말을 듣고 처음에는 무슨 의미의 API 문서를 요청하시는 건지 몰라서 내가 이해한 바가 맞는지 여쭤보기도 했다.

똑똑하신 프론트 팀원분께서는 바로 알아들으셔서 노션에 데이터 형식을 적으셨다고 하시기에 참고하고자 구경을 갔는데..

 

으악ㅋㅋㅋ선생님...!! 아무리 우리 팀원이고 같은 포지션이지만ㅋㅋㅋㅋㅋㅋ 이건 커버를 쳐줄 수 없겠어요..!!ㅋㅋㅋ

 

결국 저 내용을 읽어보신 백엔드 분과 따로 얘기를 나누셨다고 했는데, 해당 사항을 공유해주시지 않아서 정보의 차이가 있음을 인지하게 되었고 개인사정으로 프로젝트를 관두는 인원이 발생할 수 있기에 함께 공유하는 것을 요청드렸다.

감사하게도 요청드린 이후부터 슬랙에 공유를 해주셔서 너무 감사했다. 제가 좀 많이 까다롭긴 하지만 다 이유가 있는 것이니 양해를 부탁드려봅니다.. 🙇‍♂️🙇‍♀️

 

아무튼 다시 본론으로 가자면, 프론트엔드에서 먼저 API 문서화해보는 것이 이번의 주제이다.

맨땅에 헤딩 😗

 백엔드 영역이라고만 생각했던 부분이였지만, 고정관념일 수도 있겠다는 생각이 들었고 불가능한 영역도 아니라고 생각했기에 프론트 팀원과 함께 시간을 잡아 3시간+@ 동안 게더타운에서 논의를 나눴다.

페이지가 생각보다 많아서 오래 걸려서 팀원분이 엄청.. 힘들어하시는 게 보였다. (안돼요! 정신줄 잡아!)

1차적으로 URI를 제외한 예상 데이터에 대해서만 의논 후, 나머지 작업은 혼자 작성한 후에 팀원분께 컨펌을 요청했다.

 

API 작성은 포스트맨을 사용했다.

처음에는 문서를 어디서 작성해드려야 하는거지..? 노션에 표로 정리해서 드려야하나..?싶었지만...... 아.. 노션은 안돼!

사실 나의 첫 사이드 프로젝트에서 백엔드 개발자분께 노션으로 API를 받았었던 기억이 그다지 좋지 않았었기에 포스트맨을 채택했다. 데이터의 형식이라던가 내가 응답받는 데이터 등의 정보가 명확하지 않아서 문서만으로는 이해하기 어려웠던 부분이 많아서 개별적으로 계속 질문하는 게 죄송스러웠을 정도........ㅜㅜ

 

없느니만 못하는 문서가 될 거면 작성을 안하는 편이 더 낫다고 생각했기에 계속 고민하고 수정했던 것 같다.

그럼에도 뭐..초보 티가 나는 건 어쩔 수 없겠지만....

REST ful한 URI 작성도 겸사겸사 고민해봤는데 쉽지 않았다..... 😥😥 리소스의 위치..? 그게 뭐죵 😂

 

시간은 꽤 오래걸렸지만 새로운 경험을 쌓았다는데 의의를 두고자 한다.

백엔드 팀원 분들에게 이 문서가 휴지조각이 아니었기를 바라며..ㅋㅋㅋㅋ

다들 너무 착하셔서 휴지조각이어도 '아.. 이 문서는 참고할 가치가 없겠어요.'와 같은 엄청 직설적인 말씀은 안 하시겠지만..ㅠ