API 설계

💻 API 명세서

https://youtube-community.gitbook.io/youtube-community/

🗂️ 개선 사항

🔢 다음과 같은 장점에 GitBook 을 사용하여 api 명세서를 작성하였습니다.

간편하고 직관적인 사용성: GitBook은 사용자 친화적인 인터페이스를 제공하여 쉽고 빠르게 문서를 작성하고 관리할 수 있습니다. Markdown과 같은 마크업 언어를 사용하여 문서를 작성하므로 개발자와 비개발자 모두 쉽게 사용할 수 있습니다.
자동 저장 및 백업: GitBook은 작성 중인 문서를 자동으로 저장하여 데이터 손실을 방지합니다. 또한, Git과 연동하여 문서를 온라인 저장소에 저장하여 백업 및 협업이 용이합니다.
편리한 협업 기능: GitBook은 여러 사용자가 동시에 문서를 편집하고 관리할 수 있도록 편리한 협업 기능을 제공합니다. 여러 사람이 함께 작업하거나 리뷰를 쉽게 할 수 있어 팀 프로젝트나 공동 저작에 적합합니다.
다양한 포맷 지원: GitBook은 다양한 출력 포맷을 지원합니다. HTML, PDF, ePub 등 다양한 형식으로 문서를 내보낼 수 있어서 여러 환경에 맞게 문서를 공유하거나 배포할 수 있습니다.

하지만, 모든 문서를 작성 해야해 휴먼오류 발생, 변경사항이 있을때마다 직접 수정을 해야해 유지보수 관리가 어려워 api 자동화 프레임워크(Swagger .. 등)를 도입해 개선할 예정입니다.

🔢 목록 조회 시 파라미터에 한글 사용

목록 조회 시 정렬 기준을 한글로 사용했으나, 한글로 된 정렬 기준은 사용자들이 이해하기 어렵고, 통일성이 떨어져 API 사용에 혼동을 줄 수 있어 recent, popular, latest 등 정렬기준을 영단어로 변경하여 개선하였습니다.