시작하기

이 문서는 한국공학대학교 컴퓨터공학부 2024 졸업작품 “노티(NOTI)”에 대한 전반적인 이해를 돕고자 만들어진 문서입니다.

규칙

모든 API 요청을 전송하는 기본 URL은 http://localhost:3000 이며, 안드로이드 개발의 경우 http://{자신의 IPv4 아이피}:3000 로 사용하시면 됩니다.

NOTI의 API는 페이지와 데이터베이스 리소스에 대한 GET, POST, PUT, DELETE 요청을 통해 대부분 작업을 수행하며 모든 API 통신에는 기본적으로 JSON 형식이 이용됩니다.

카카오로그인 SDK

NOTI의 회원가입 및 로그인 방식은 카카오로그인 API를 활용한 로그인 방식을 사용하기에 카카오계정이 필요합니다.

객체

사용자 , 즉 유저의 아이디(userID)는 대부분의 API호출에 Pathvariable 형태로 이용됩니다.

속성	업데이트 가능	유형	설명	예시 값
`user_id`	`Read-Only`	`int`	`user 테이블의 기본 키`	`125`
`user_color`	`Read & Write`	`string`	`사용자가 선택한 테마`	`PinkTheme`
`user_nickname`	`Read & Write`	`string`	`사용자 닉네임`	`이지현`
`user_profile`	`Read & Write`	`string`	`사용자의 프로필 이미지`	`data:image/jpeg;base64,/9j/4QCkRXhpZgAATU0AKg...`
`mute_start_time`	`Read & Write`	`string`	`방해 금지 시작 시간`	`17:50`
`mute_end_time`	`Read & Write`	`string`	`방해 금지 종료 시간`	`16:34`
`diary_time`	`Read & Write`	`string`	`일기 생성 시간`	`02:32`
`kakao_id`	`Read-Only`	`int`	`카카오 측 고유 유저 번호`	`3321442137`
`kakao_email`	`Read-Only`	`string`	`카카오 이메일`	`cssukim0205@gmail.com`

속성	업데이트 가능	유형
`todo_id`	`Read-Only`	`int`
`user_id`	`Read & Write`	`string`
`todo_title`	`Read & Write`	`string`
`todo_start_time`	`Read & Write`	`string`
`todo_end_time`	`Read & Write`	`string`
`todo_done`	`Read & Write`	`boolean`
`todo_color`	`Read & Write`	`string`
`todo_date`	`Read & Write`	`string`