[Docs] API 명세서 문서 작업

coldrain-f / whale-voca

日本語 상용한자 2,136자와 관련 단어들을 효율적으로 암기할 수 있는 단어 암기 모바일 앱 서비스입니다.

0 stars 0 forks source link

Closed coldrain-f closed 9 months ago

coldrain-f commented 10 months ago

API 명세서 관련하여 팀 미팅을 진행하여 API 명세서 도출 필요 기본적으로는 Notion이나 마크다운 Table로 기본 명세서를 설계한다.

Ksinny commented 9 months ago

지난 회의를 바탕으로 작성한 API 명세서입니다. 피드백 부탁드려요!

coldrain-f commented 9 months ago

학습 히스토리는 학습이 종료될 때마다 사용자 핸드폰에 직접 저장할 생각이라, 대시보드에서 CRUD 개발이 없을 것 같습니다. 따라서 API 명세서에서 제거해도 될 것 같습니다.

그리고 word가 복수형이 아니던데 단수로 하신 이유가 있을까요? 별도의 이유가 없다면 words로 변경하면 어떨까 싶습니다.

Ksinny commented 9 months ago

학습 히스토리 제거하고, words로 수정 완료했습니다 감사합니다!

coldrain-f commented 9 months ago

이슈 닫겠습니다. 감사합니다.