[TIL] API Document 생성 방식

오늘 한일

• 요구사항 파악
• API 문서 작성

작업 내용

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

API문서는 Restful API의 작업 내용을 기록하는 문서인데 자원, 주소, 행위를 표현할 수 있다.

이 과정에서 나타내는 방식은 도메인 기반, 화면단 플로우 기반, 유즈케이스 기반, 비즈니스 로직 기반으로 URL과 Method를 표현할 수 있다.
이 방식에 대해서 유광열 튜터님이 알려주신 부분을 잘 확인할 수 있도록 공부가 추가로 필요하다.

이전에 공부했던 RestfulAPI의 성숙도 모델에 대해서도 떠올라서 다시 공부하고 기록하기로 했다.
오늘은 팀원도 개인적인 일이 많아서 문서작업을 다른 한 분과 맡아서 진행하게되어 매우 바쁘니 다른 분이 올린걸로 공부를했다.
API성숙도모델

문제 해결

• API 생성 방식에 대한 여러 종류가 있기에 이를 내용 정리함

내일 할 일

• API Document 외 다른 문서들 피드백 받기