To-do API specification 설계하기

[ramyo564]

1. 할 일 (Task) 관리 API 구현

• 할 일(Task)의 목록 조회, 등록, 수정, 삭제 기능을 작성했으며, 엔드포인트는 다음과 같습니다.
  • GET /tasks: 모든 할 일(Task) 목록을 조회
  • POST /tasks: 새로운 할 일을 등록
  • PUT /tasks: 할 일 전체 내용 수정
  • PATCH /tasks/{taskId}: 할 일 부분 내용 수정
  • DELETE /tasks/{taskId}: 할 일 삭제

2. 상태 확인 API 추가

• 서버 상태를 확인할 수 있는 엔드포인트 /를 추가했습니다. 서버가 정상 작동하는지 확인하는 용도로 사용되며, 정상일 경우 200 응답을 반환합니다.

3. 데이터 모델 정의

• Task 모델에 대한 명확한 정의를 제공하여 id, title, contents, createdAt, updatedAt, deletedAt, taskDone, isDeleted 필드를 포함했습니다.

4. 응답 형식 표준화

• 모든 API 응답에 대해 일관된 JSON 형식을 사용하여 클라이언트 개발의 편의성을 높였습니다.

5. 개선 사항: API 엔드포인트 책임 분리

PUT 메소드 (PUT /tasks)

• 목적: 할 일의 전체 내용을 수정
• 사용 사례: 제목, 내용 등 여러 필드를 동시에 업데이트할 때

PATCH 메소드 (PATCH /tasks/{taskId})

• 목적: 할 일의 완료 상태만을 변경
• 사용 사례: 사용자가 할 일을 완료했을 때 상태만 빠르게 업데이트

개선 이유:

• 명확한 기능 구분: 각 엔드포인트가 단일 책임을 가지도록 설계
• 사용 편의성 향상: 상태 변경과 내용 수정을 별도로 처리하여 API 사용의 유연성 증가
• 유지보수 용이성: 기능별로 분리되어 있어 향후 수정이나 확장이 용이함

6. 명확한 API 문서화

OpenAPI 3.0.3 형식을 사용하여 API의 동작과 데이터 구조를 명확히 문서화했습니다. 이는 팀 간 커뮤니케이션과 API 이해도를 높이는 데 도움이 됩니다.