Todo API 문서 | 구독 관리 API 문서

Todo API 문서

• Task - 할 일을 관리하는 API

   GET /tasks
   GET /tasks/:id
  POST /tasks
DELETE /tasks/:id
 PATCH /tasks/:id

• 속성
  • _id: string - Task 객체에 대한 고유 식별자
  • title: string - 태스크 제목(최대 30자)
  • description: string - 태스크 상세 설명
  • isComplete: boolean - 태스크 완료 여부
  • createdAt: string - 객체가 생성된 시점에 타임스탬프... YYYY-MM-DDTGG:MM:SS.SSSZ 사용, 자동 생성 필드
  • updatedAt: string - 객체가 수정된 시점에 타임스탬프 ... YYYY-MM-DDTGG:MM:SS.SSSZ 사용, 자동 생성 필드
• 목록 조회
  • 엔드포인트 : GET /tasks
  • 쿼리 스트링 파라미터
    • sort: string - oldest인 경우 오래된 순으로 정렬, 그 외 모든 경우 최신 순서로 정렬
    • count: integer - 리턴 받기 원하는 객체 수 : 값을 전달하지 않으면 모든 객체 리턴
  • 리턴 내용 : Task 객체의 목록 리턴... 실패 시 에러 상태 코드와 메시지 리턴
• 조회
  • 엔드포인트 : GET /tasks/:id
  • 리턴 내용 : 유효한 고유 식별자 제공시 Task 객체 리턴... 실패시 에러 상태 코드와 메시지 리턴
• 생성
  • 엔드포인트 : POST /tasks
  • 바디 파라미터
    • title: string (필수) - 태스크 제목(30자 이내)
    • description: string - 태스크 상세 설명
  • 리턴 내용 : 생성 성공시 Task 객체 리턴, 실패시 에러 상태 코드, 메시지 리턴
• 수정
  • 엔드포인트 : PATCH /tasks/:id
  • 바디 파라미터
    • title: string - 제목(30자 이내)
    • description: string - 상세 설명
    • isComplete: boolean - 완료 여부
  • 리턴 내용 : 수정 성공시 Task 객체 리턴, 실패시 에러 상태 코드, 메시지 리턴
• PATCH vs PUT : PATCH는 데이터를 부분 수정시 사용 | PUT은 데이터를 아예 새로운 데이터로 덮어쓸 때 사용
• 삭제
  • DELETE /tasks/:id
  • 리턴 내용 : 성공시 204 상태 코드 리턴, 실패시 에러 상태 코드, 메시지 리턴

---

Subscription API 문서

• 구독을 관리하는 API

   GET /subscriptions
   GET /subscriptions/:id
  POST /subscriptions
DELETE /subscriptions/:id
 PATCH /subscriptions/:id

• 속성
  • _id: stirng - 고유 식별자
  • name: string - 구독 서비스 이름(최대 20자)
  • price: number - 구독 요금
  • cycle: string - 결제 주기(m or y)
  • firstPaymentDate: string - 첫 결제일(YYYY-M-DDTHH:MM:SS.SSSZ)
  • memo: string - 구독에 대한 메모
  • createdAt: string - 객체 생성 시점에 대한 타임스탬프... YYYY-M-DDTHH:MM:SS.SSSZ, 자동 생성 필드
  • updatedAt: string - 객체 수정 시점에 대한 타임스탬프 ... YYYY-M-DDTHH:MM:SS.SSSZ, 자동 생성 필드
• 목록 조회 : 객체 전체 목록을 최신 순서로 리턴
  • GET /subscriptions
  • 쿼리스트링 파라미터
    • sort: string - price인 경우 높은 요금 순으로 정렬, 그외 모든 경우 생성순으로 정렬
• 조회
  • GET /subscriptions/:id
  • 리턴 내용 : 고유 식별자 제공시 Subscription 객체 리턴, 실패시 에러 상태 코드, 메시지 리턴
• 생성
  • POST /subscriptions
  • 바디 파라미터
    • name: string - 구독 서비스 이름(20자 이내, 필수)
    • price: number - 구독 요금(0 이상 숫자, 필수)
    • cycle: string - 결제 주기(m or y, 필수)
    • firstPaymentDate: string - 첫 결제일(필수, 시간 입력 안해도 됨)
    • memo: string - 구독에 대한 메모
  • 리턴 내용 : 성공시 객체 리턴, 실패시 에러상태코드+ 메시지 리턴
• 수정
  • PATCH /subscriptions/:id
  • 바디 파라미터
    • name: string - 구독 서비스 이름(20자 이내)
    • price: number - 구독 요금(0 이상의 숫자)
    • cycle: string - 결제 주기(m or y, 필수)
    • firstPaymentDate: string - 첫 결제일(필수, 시간 입력 안해도 됨)
    • memo: string - 구독에 대한 메모
  • 리턴 내용 : 성공시 객체 리턴, 실패시 에러상태코드+ 메시지 리턴
• 삭제
  • DELETE /subscriptions/:id
  • 리턴 내용 : 성공시 204 상태 코드 리턴, 실패시 에러상태코드+메시지 리턴