API Documents

API 설계

User API를 제외한 모든 API에 header로 인증 token값을 넣는다.

headers:{
 'Authorization': 'Bearer ${tokenString}'
}

User

Method	url	description
GET	api/user/oauth/naver	naver 아이디로 로그인
GET	api/user/me	사용 중인 user의 정보 확인

Project

Project CRUD

Method	url	description
GET	api/project	project 전체 조회
GET	api/project/:projectId	project 개별 조회
POST	api/project	project 생성
PATCH	api/project/:projectId	project 제목 수정
PUT	api/project/:projectId	project 수정
DELETE	api/project/:projectId	project 삭제

Section CUD

Method	url	description
POST	api/project/:projectId/section	section 생성
PATCH	api/project/:projectId/section/:sectionId	section 제목 수정
DELETE	api/project/:projectId/section/:sectionId	section 삭제

Task

Task CRUD

Method	url	description
GET	/api/task/:taskId	task 개별 조회
POST	api/task	task 생성
PATCH	api/task/:taskId	task 수정
DELETE	api/task/:taskId	task 삭제

Alarm CRUD

Method	url	description
POST	/api/task/:taskId/alarm	개별 task 알람 추가
PUT	/api/task/:taskId/alarm	개별 task 알람 변경
DELETE	/api/task/:taskId/alarm	개별 task 알람 삭제

Comment CRUD

Method	URL	Description
GET	/api/task/:taskId/comment	task에 달린 모든 comment 조회
POST	/api/task/:taskId/comment	task에 comment 생성
PUT	/api/task/:taskId/comment/:commentId	task에 달린 comment 수정
DELETE	/api/task/:taskId/comment/:commentId	task에 달린 comment 삭제

Bookmark CRUD

Method	URL	Description
GET	/api/task/:taskId/bookmark	bookmark 전체 조회
POST	/api/task/:taskId/bookmark	bookmark 생성
PUT	/api/task/:taskId/bookmark/:bookmarkId	bookmark 수정
DELETE	/api/task/:taskId/bookmark/:bookmarkId	bookmark 삭제

Label

Method	URL	Description
GET	api/label	label 전체 조회
POST	api/label	label 생성
PUT	api/label/:labelId	label 수정
DELETE	api/label/:labelId	label 삭제