api document

커넥트클래스 API 문서

만들어야할 API 대분류

• 질문 (roomNumber를 가지고)
  • 조회
  • 추가
• 스터디
  • 스터디 추가
  • 스터디 제거
  • 스터디 자료 업로드
  • 스터디 자료 다운로드
  • 참여인원 관리
  • 스터디 목록 조회
  • 소켓
• 회원정보
  • 출결 관리
  • 회원 정보 수정
• Auth (권한 확인)
  • 로그인(signin)
  • 소셜로그인(카카오, 네이버, 구글)
  • 회원탈퇴
• 토큰 검사 validation
• 데이터베이스 레이어

프론트엔드(사용자) => 서비스 Layer => Token 검사 Layer => 서비스 Layer => 프론트엔드(사용자)

토큰검사 레이어와 디비 레이어에 트래픽 몰림 (나중에 오토스케일링, LB로 해결)

강의 중간에 슬라이드 추가 기능은 안하는것으로 강의 중간에 필기만을 위한 layer 만들기? NoSQL로 현재 방에 인원정보

Response

{
    success : true,
    message : "",
    data : {
        list:[],
    }
}

apiDoc을 사용

데모 링크

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */