API Documentation

목차

1. 유저 관리
   • 회원 가입
   • 로그인
   • 오늘 첫 로그인 여부 확인
   • 유저 정보
2. 할 일 관리
   • 할 일 추가하기
   • 할 일 삭제하기
   • 할 일 수정하기
   • 유저의 할 일 목록 가져오기
3. 캘린더
   • 이번 달 할 일 목록 가져오기
   • 지정 달의 할 일 목록 가져오기
4. 식물 관리
   • 오늘의 보상 지급
   • 식물 정보
   • 식물 도감

---

유저 관리

회원 가입

URI: /user/register

메서드: POST

설명: 새로운 유저를 등록합니다.

파라미터:

이름	타입	설명	필수 여부
id	String	유저 ID	O
password	String	비밀번호	O
nickname	String	닉네임	O

응답:

코드	설명
1	회원 가입 성공
2	회원 가입 실패: ID 중복

---

로그인

URI: /user/login

메서드: POST

설명: 유저가 로그인합니다.

파라미터:

이름	타입	설명	필수 여부
id	String	유저 ID	O
password	String	비밀번호	O

응답:

코드	설명
1	로그인 성공
2	로그인 실패: 비밀번호 오류
3	로그인 실패: ID 없음

---

오늘 첫 로그인 여부 확인

URI: /user/daily-login-checking

메서드: POST

설명: 유저가 오늘 보상을 받았는지 확인합니다.

파라미터:

이름	타입	설명	필수 여부
id	String	유저 ID	O

응답:

코드	설명
0	어제 보상을 받지 않음
1	어제 보상을 이미 받음

---

유저 정보

URI: /user/info

메서드: GET

설명: 유저 ID로 유저 정보를 가져옵니다.

파라미터:

이름	타입	설명	필수 여부
uid	String	유저 ID	O

응답 예시:

"betterjeong"

---

할 일 관리

할 일 추가하기

URI: /todos/add

메서드: POST

설명: 새로운 할 일을 추가합니다.

파라미터:

이름	타입	설명	필수 여부
id	String	유저 ID	O
date	LocalDate	날짜 (형식: yyyy-mm-dd)	O
toDo	String	할 일 내용	O
toDoVisibilityCalendar	Boolean	캘린더 표시 여부	O

응답:

코드	설명
1	할 일 추가 성공
2	할 일 추가 실패

---

할 일 삭제하기

URI: /todos/delete

메서드: POST

설명: 할 일을 삭제합니다.

파라미터:

이름	타입	설명	필수 여부
toDoId	Integer	삭제할 할 일 ID	O

응답:

코드	설명
1	할 일 삭제 성공
2	할 일 삭제 실패

---

할 일 수정하기

URI: /todos/update

메서드: POST

설명: 할 일을 수정합니다.

파라미터:

이름	타입	설명	필수 여부
toDoId	Integer	수정할 할 일 ID	O
userId	String	유저 ID	O
date	LocalDate	날짜 (형식: yyyy-mm-dd)	O
toDo	String	할 일 내용	O
toDoVisibilityCalendar	Boolean	캘린더 표시 여부	O

응답:

코드	설명
1	할 일 수정 성공
2	할 일 수정 실패

---

유저의 할 일 목록 가져오기

URI: /todos/all

메서드: GET

설명: 특정 유저의 모든 할 일을 가져옵니다.

파라미터:

이름	타입	설명	필수 여부
user_id	String	유저 ID	O

응답 예시:

[
    {
        "id": 1,
        "date": "2023-04-25",
        "toDo": "테이블 수정",
        "toDoCompleted": false
    }
]

---

캘린더

이번 달 할 일 목록 가져오기

URI: /calendar/dates

메서드: GET

설명: 이번 달의 할 일 목록을 가져옵니다.

파라미터:

이름	타입	설명	필수 여부
user_id	String	유저 ID	O

응답 예시:

[
    {
        "id": 7,
        "date": "2023-05-09",
        "toDo": "테이블 재수정",
        "toDoCompleted": false
    }
]

---

지정 달의 할 일 목록 가져오기

URI: /calendar/months

메서드: POST

설명: 특정 달의 할 일 목록을 가져옵니다.

파라미터:

이름	타입	설명	필수 여부
user_id	String	유저 ID	O
year	Int	연도	O
month	Int	월	O
day	Int	일	O

응답 예시:

[
    {
        "id": 1,
        "date": "2023-04-25",
        "toDo": "테이블 수정",
        "toDoCompleted": false
    }
]

---

식물 관리

오늘의 보상 지급

URI: /plant/today-reward

메서드: POST

설명: 유저에게 오늘의 보상을 지급합니다.

파라미터:

이름	타입	설명	필수 여부
id	String	유저 ID	O

응답 예시:

{
    "totalCount": 2,
    "plantObtained":{
        "1": 1,
        "2": 1
    }
}

---

식물 정보

URI: /plant/information

메서드: GET

설명: 특정 식물에 대한 정보를 가져옵니다.

파라미터:

이름	타입	설명	필수 여부
name	String	식물 이름	O

응답 예시:

{
    "id": 1,
    "name": "test",
    "description": "test용 꽃"
}

---

식물 도감

URI: /garden/user

메서드: GET

설명: 유저의 식물 도감 정보를 가져옵니다.

파라미터:

이름	타입	설명	필수 여부
user_id	String	유저 ID	O

응답 예시:

[
    {
        "id": 18,
        "plantName": "test",
        "count": 0,
        "found": false
    }
]