[일정관리앱 만들기-1] Level 0: API 명세서 및 ERD 작성

필수 기능(Lv2, DB연결 보류...)까지만 구현한다는 전제 하에 작성된 API명세서 및 ERD입니다.

---

📍 API 명세서

기능	Method	URL	request	response	상태코드
일정 생성	POST	/schedules	요청 body { "content" : "할일", "writer" : "작성자명", "password" : "비밀번호" } "recordDate" : 작성일", "modifyDate" : "수정일" "scheduleID" :식별자ID"	등록 정보 { "scheduleID" : "식별자" }	200: 정상등록
전체 일정 조회	GET	/schedules	요청 param	다건 응답 정보 [  { "modifyDate" : "수정일", "name" : "작성자명" } ]	200: 정상조회
선택 일정 조회	GET	/schedules/{scheduleId}	요청 param	단건 응답 정보 { "content" : "할일", "name" : "작성자명", "recordeDate" : "작성일" }	200: 정상조회
선택 일정 수정	PUT	/schedules/{scheduleId}	요청 body { "content" : "할일", "name" : "작성자명", "password" : "비밀번호" }	수정 정보 { "content" : "할일", "name" : "작성자명", "recordeDate" : "수정일" }	200: 정상수정
선택 일정 삭제	DELETE	/schedules/{scheduleId}	요청 param { "password" : "비밀번호" }	-	200: 정상삭제

 

📍 튜터님 피드백

✔️ 서버에서 처리하는 값은 request의 body에 포함하지 않는다.

request body에는 클라이언트에게 입력받을 값만 넣기 때문에 서버에서 처리하는 값은 안넣는게 맞음
(작성일,수정일,식별자ID)

 

✔️ 일정 생성 후 식별자(ID)는 응답(Response)으로 포함한다.

필수는 아니지만, 일반적으로 일정을 생성하면 생성한 ID를 응답해준다.

 

✔️ 전체일정 조회 시 리스트 형태로 응답한다.

여러 개의 일정 데이터를 반환하므로 배열[] 형식으로 표현 (블로그 들어가면 제목만 보이는 것 처럼!!) 

예시 코드 ⬇️

[
  { "id": 1, "title": "회의", "date": "2025-03-12" },
  { "id": 2, "title": "스터디", "date": "2025-03-13" }
]

 

✔️ DELETE 요청은 body가 보통 없어야 한다.

RESTful 설계 원칙에 따라 DELETE 요청은 요청 바디를 사용하지 않는 것이 일반적이다.
(하지만 지금 수준에서 일단 넘어가도 된다. 숙련단계에서 토큰이랑 이것저것 배우면 알게될 내용이라고 하셨다)

---

📍 ERD

수정 전

 

📍 튜터님 피드백

ERD
<Schedule>
- scheduleID (int)
- content (varchar)
- recordDate (date)
- modifyDate (date)
- password (varchar)

<Writer>
- writer(varchar)

이렇게 먼저 들고갔다가 받은 피드백

- 데이터타입 varchar 사용시 몇글자 할지 작성하기

- 도전과제가 아니라면 ERD에서 개체 하나로만 해도 괜찮음

 

+ 팀원분이 받은 피드백 내용!

(나는 도전과제(DB연결)은 포기하고, 필수단계 구현이 목표라고 해서 해당 내용에 대한 피드백을 따로 안해주신 듯 하다.)

1. 데이터베이스는 스네이크 케이스 사용

2. 데이터베이스에서는 데이터 타입을 '도메인'이라고 부른다.

　 따라서 도메인 종류와 어떤 프로그램이 어떤 도메인과 연결되는지 알아야 한다!

3. API명세서에 URL을 /plans으로 작성했으면, ERD 제목도 동일하게 plan으로 맞춰야 함.

---

+ 가이드에서 이해가 안됐던 부분...

과제 가이드에서 이 내용이 이해가 안됐었는데 리스트로 구현하라는 뜻인 것 같다. (API 명세서 튜터님 피드백 3번째부분)