API 명세서

schedule

기능	Method	URL	request	response	상태코드
일정 등록	POST	/api/schedules	body: 일정생성요청 DTO	등록 정보	201: 정상등록 400: 오류
일정 조회	GET	/api/schedules/{scheduleId}	-	단건 응답 정보	200: 정상조회 404: 오류
일정 목록 조회	GET	/api/schedules	param: 페이지 번호 페이지 크기 작성자명 수정날짜	다건 응답 정보	200: 정상조회 400: 오류
일정 수정	PUT	/api/schedules/{scheduleId}	body: 일정수정요청 DTO	수정 정보	200: 정상수정 406: 오류
일정 삭제	DELETE	/api/schedules/{scheduleId}	body: 일정삭제요청 DTO	-	200: 정상삭제 406: 오류

일정 등록

• 요청 정보

  메소드	요청 URL
  POST	/api/schedules

• 예시

  • 요청: POST /api/schedules

  {     
        "writerId" : 1,
        "password" : "abc!123",
        "todo" : "나는 오늘 강의를 들을 것이다."
  }

  • 응답: HTTP/1.1 201 Created

  {
        "scheduleId" : 3,
        "writerId" : 1,
        "todo" : "나는 오늘 강의를 들을 것이다.",
        "createdDate" : "2024-10-31",
        "editDate" : "2024-10-31"
  }

• 본문

  • 요청

    이름	타입	설명	필수
    writerId	int		필수
    password	문자열		필수
    todo	문자열		필수

  • 응답

    이름	타입	설명	필수
    scheduleId	int		필수
    writerId	int		필수
    todo	문자열		필수
    createdDate	문자열->DATETIME		필수
    editDate	문자열->DATETIME		필수

일정 목록 조회

• 요청 정보

  메소드	요청 URL
  GET	/api/schedules?pageNumber=XX&pageSize=XX&&writer=XX&date=XX

• 예시

  • 요청: GET /api/schedules?pageNumber=1&pageSize=5&&writer=익명1&date=2024-11-01

  • 응답: HTTP/1.1 200 OK

  "schedules" : [
    {
        "scheduleId" : 3,
        "writerId" : 1,
        "todo" : "나는 오늘 강의를 들을 것이다.",
        "createdDate" : "2024-10-31",
  },
  {
        "scheduleId" : 2,
        "writerId" : 1,
        "todo" : "나는 오늘 강의를 들을 것이다.",
        "createdDate" : "2024-10-31",
  }
  ]

• 본문

  • 요청 x

  • 응답

    이름	타입	설명	필수
    scheduleId	int		필수
    writerId	int		필수
    writer	문자열		필수
    todo	문자열		필수
    editDate	문자열->DATETIME		필수

일정 단건 조회

• 요청 정보

  메소드	요청 URL
  GET	/api/schedules/{scheduleId}

• 예시

  • 요청: GET /api/schedules/2

  • 응답: HTTP/1.1 200 OK

  {
        "scheduleId" : 2,
        "writerId" : 1,
        "todo" : "나는 오늘 강의를 들을 것이다.",
        "createdDate" : "2024-10-31",
  }
  

• 본문

  • 요청 x

  • 응답

    이름	타입	설명	필수
    scheduleId	int		필수
    writerId	int		필수
    todo	문자열		필수
    createdDate	문자열->DATETIME		필수

일정 수정

• 요청 정보

  메소드	요청 URL
  PUT	/api/schedules/{scheduleId}

• 예시

  • 요청: PUT /api/schedules/{scheduleId}

  {
        "scheduleId" : 2,
        "password" : "abc!123",
        "todo" : "나는 오늘 쉴 것이다." -> 수정된 내용
  }

  • 응답: HTTP/1.1 200 OK

  {
        "scheduleId" : 2,
        "todo" : "나는 오늘 쉴 것이다.",
        "editDate" : "2024-11-1"
  }

• 본문

  • 요청

    이름	타입	설명	필수
    scheduleId	int		필수
    password	문자열		필수
    todo	문자열		필수

  • 응답

    이름	타입	설명	필수
    scheduleId	int		필수
    todo	문자열		필수
    editDate	문자열->DATETIME		필수

일정 삭제

• 요청 정보

  메소드	요청 URL
  DELETE	/api/schedules/{scheduleId}

• 예시

  • 요청: DELETE /api/schedules/13

  {
        "password" : "abc!123"
  }

  • 응답: HTTP/1.1 200 OK

  {
       13
  }

writer

기능	Method	URL	request	response	상태코드
작성자 등록	POST	/api/writers	body: 작성자생성요청 DTO	작성자 정보	201: 정상등록 400: 오류
작성자 조회	GET	/api/writers/{writerId}	-	작성자 정보	200: 정상조회 404: 오류
작성자 수정	PUT	/api/writers/{writerId}	body: 작성자수정요청 DTO	수정된 정보	200: 정상조회 406: 오류
작성자 삭제	DELETE	/api/writers/{scheduleId}	-	-	200: 정상삭제

작성자 등록

• 요청 정보

  메소드	요청 URL
  POST	/api/writers

• 예시

  • 요청: POST /api/writers

  {     
        "email" : "a@b.com",
        "name" : "아무개1"
  }

  • 응답: HTTP/1.1 201 Created

  {
        "writerId" : 1,
        "email" : "a@b.com",
        "name" : "아무개1",
        "createdDate" : "2024-10-31",
        "editDate" : "2024-10-31"
  }

• 본문

  • 요청

    이름	타입	설명	필수
    email	문자열		필수
    name	문자열		필수

  • 응답

    이름	타입	설명	필수
    writerId	int		필수
    email	문자열		필수
    name	문자열		필수
    createdDate	문자열->DATETIME		필수
    editDate	문자열->DATETIME		필수

작성자 단건 조회

• 요청 정보

  메소드	요청 URL
  GET	/api/writers/{writerId}

• 예시

  • 요청: GET /api/writers/1

  • 응답: HTTP/1.1 200 OK

  {
        "writerId" : 1,
        "email" : "a@b.com",
        "name" : "아무개1"
  }

• 본문

  • 요청 x
  • 응답

    이름	타입	설명	필수
    writerId	int		필수
    email	문자열		필수
    name	문자열		필수

작성자 수정

• 요청 정보

  메소드	요청 URL
  PUT	/api/writers/{writerId}

• 예시

  • 요청: PUT /api/writers/1

  {
        "email": "b@c.com", -> 수정된 내용
        "name" : "아무개1"
  }

  • 응답: HTTP/1.1 200 OK

  {
        "writerId" : 1,
        "email": "b@c.com",
        "name" : "아무개1",
        "editDate" : "2024-11-1"
  }

• 본문

  • 요청

    이름	타입	설명	필수
    email	문자열		필수
    name	문자열		필수

  • 응답

    이름	타입	설명	필수
    writerId	int		필수
    email	문자열		필수
    name	문자열		필수
    editDate	문자열->DATETIME		필수

작성자 삭제

• 요청 정보

  메소드	요청 URL
  DELETE	/api/writers/{writerId}

• 예시

  • 요청: DELETE /api/writers/{writerId}
  • 응답: HTTP/1.1 200 OK

ERD

---