[TIL] API Document 생성 방식
·
TIL
오늘 한일요구사항 파악API 문서 작성작업 내용백엔드 팀원들과 온라인으로 협업은 또 처음이라 어떻게 시작해야 할지 막막했지만 서로의 경험을 공유하고 요구사항을 파악하면서 API문서를 작성하다보니 어찌저찌 완성되어 가고 있다.유광열 튜터님에게 dto작성을 먼저하는게 처음이라 많이 힘들다고 했더니 원래 신규 개발자들이 도메인 기준으로 테이블을 먼저 작성하지만 이렇게 API 문서와 Request, ResponseDTO를 먼저 작성하면 중간에 빠트릴 수 있는 데이터들을 많이 발견하게되고 전자의 방식보다 훨씬 작업 효율이 좋다고 하셨다. 이번 기회에 API 문서를 작성하는 역량또한 2배 아니 3배이상 기를 수 있도록 하고있다.API문서는 Restful API의 작업 내용을 기록하는 문서인데 자원, 주소, 행위를 ..