API

API 문서

• https://bmrdevteam.github.io/altsis-docs/api/APIs.html
• backend>controllers 폴더 내의 각 컨트롤러 파일에서 jsdoc으로 문서를 정의한다
• npm run jsdoc 실행 시 backend>docs에 html 파일이 생성됨 -> 이를 개발 문서 업로드 레포에 업로드한다

클라이언트에서 API 호출하는 방법

• frontend>...>hooks>useAPIv2 훅으로 API를 정의하고 호출할 수 있다
• useAPIv2에서 사용하는 API 이름과 API 문서에서의 API 이름은 동일하다

API 버그 해결 예시

1. 학기 생성 기능에 버그 발견
2. 클라이언트에서 학기 생성에 어떤 API를 사용하는지 확인한다 ex) CSeason API
3. API 문서에서 CSeason API를 찾고 요청을 제대로 보냈는지 확인
4. 요청을 제대로 보냈다면 backend 폴더에서 "CSeason"을 검색하여 해당 API 코드 확인
5. 응답에 에러 메시지가 있다면 해당 에러 메시지를 보내는 부분을 찾아 원인 파악
6. 버그 수정 후 배포