오늘부터 일주일 동안 진행하는 팀프로젝트를 시작했다.
팀장으로 처음 진행하는 프로젝트라서 S.A작성하거나 API명세를 작성 할 때 이전보다 더 많은
부담을 가지고 시작하게 됐다.
이번 프로젝트는 간단하게 고객 - 판매자 매칭 서비스를 만드는 건데 우리 팀은 프로젝트 요구사항을 보고 '당근마켓'을 생각했다. 당근마켓과 유사한 점이 많다고 느꼈고 프로젝트의 흐름을 당근마켓을 따라 하면 될 것 같다고 생각하고 진행했다.
유저는 고객이면서 동시에 판매자가 될 수도 있다. 고객은 카테고리별로 판매자를 조회하고, 판매자는 자신의 판매 카테고리를 설정할 수 있다.
운영자는 고객에게 판매자 권한을 부여하거나 삭제할 수 있다.
고객, 판매자, 운영자는 각각 조회, 수정, 삭제 기능을 구현해야 한다.
이번 프로젝트에서는 기존 프로젝트와는 다르게 API명세를 포함해서 API문서를 작성해 봤다.
API명세만 봐서는 알 것 같다가도 금방 잊는 경우가 많았는데 API문서를 작성하면서 큰 흐름을 이해하다 보니까 평소보다 시간은 더 걸렸지만 이해하기도 쉬웠고 금방 잊어버린다고 해도 문서만 보면 금방 이해할 수 있어서 좋았다.
ERD 설계를 봐도 그전에는 지켜만 봤기 때문에 시간이 조금만 흘러도 잊어버리는 부분이 많았지만 이번에는 암기가 아니라 이해를 했다고 생각해서 조금 더 편한 분위기에서 진행할 수 있을 것 같다.
API문서는 이런식으로 작성해서 한번 보면 어떤 흐름을 가지고 구현되는지 알 수 있다.
API명세는 문서를 바탕으로 금방 작성할 수 있었고 메소드명이나 변수명 등을 통일할 수 있어서 좀 더 편한것 같다.
