API 명세

1. 개요

• API 소개

  • 개발 배경 : 프로젝트에 대한 각 모델의 읽기, 쓰기, 수정하기, 삭제하기를 최대한 직관적이고 쉽게 이용할 수 있도록 하고, 개발시에는 RESTFul한 API 가 작성될 수 있도록 함.

  • 비즈니스 목적 : 프로그램 명 공부의 숲은 개인 또는 팀 단위의 학습 스케줄을 관리하고 학습 목표 및 정해진 학습 시간을 위한 타이머 기능과 습관 기록표 등을 제공하고 있음.

• 공통 요청 / 응답 형식

  • API 요청 시 데이터 형식을 JSON 형태로 데이터를 주고 받고, 응답 후에는 데이터 처리 결과를 상태 코드 status 필드에서 확인할 수 있음.

• 공통 에러

  • 각 에러에 대한 예외 Excepetion 클래스는 먼저 Error 클래스를 상속받은 HttpException 클래스를 구현하고, 각 구현하는 클래스에는 HttpException을 상속하여 다시 구현 함.

• 공통 에러 구현
  • HttpException 예외 클래스 구현

/* HttpException */
export class HttpException extends Error {
  statusCode;
  constructor(description, statusCode) {
    super(description);
    this.name = this.constructor.name;
    this.status.code = status.Code;
  }
}