[프로젝트] MOCO 모각코를 위한 웹서비스 06 - API 명세서

불편한 소통

그동안은 기능 구현을 하면 기능 테스트용 임시 탬플릿을 만들어서 동작을 확인하고
그것을 화면공유로 프론트팀에게 보여주면서 어떻게 view를 사용하면 되는지 설명했었다.

그러나 기능을 만들 때마다 일일이 영상으로 설명한다는 것이 매우 비효율적이라고 느꼈고 백엔드 팀에서 API 명세서를 만들어보기로 했다.

 

API 명세서

api 명세서를 만든 적 있는 팀원분이 노션에 틀을 제공해주셨고 기능을 만들 때마다 거기에 추가했다.

맨 위에는 파라미터에 대한 설명을 넣었다.

 

앱 별로 정리하고 색깔을 통일해서 나름 가독성을 높여보았다.

 

기능을 클릭하면 사이드에 페이지가 뜬다.

여기에서 데이터값과 context 등을 알려준다. 물론 자세한 내용을 파악하기 위해서는 코드를 봐야하지만

이렇게 한 눈에 기능이 정리되니까 코드를 찾아보는 시간이 훨씬 단축되었다. 프론트팀에서도 기능을 미리 한번 훑어보고 코드를 짤 수 있어서 소통이 훨씬 원활하게 진행되었다.

 

앞으로의 계획

현재 로그인/로그아웃을 하면 모집글 페이지로 이동하도록 고정했다.
하지만 유저는 로그인/로그아웃을 하면 자신이 보고 있던 페이지로 이동하기를 원할 것이라고 생각했다.

 

그래서 redirect를 수정하기로 결정했다.

하지만 이전 페이지로 돌아가는 방법을 아직 몰라서 구글링을 통해 공부해보려고 한다.

 

다음 포스팅은 '이전 페이지로 돌아가기' 일 것 같다.