Project API

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 삭제

Project GET API (프로젝트 전체 조회)

URL

GET /api/project

Response Description

Name	Type	Description
id	UUID	프로젝트 ID
title	STRING	프로젝트 이름
taskCount	INT	작업 개수(하위 작업 포함)
defaultSectionId	INT	첫번째 섹션 ID

Response

[
    {
        id: UUID,
        title: '프로젝트 이름',
        color: '#111111',
        isFavorite: true,
        isList: true,
        taskCount: 3,
        defaultSectionId: UUID    
    }
]

Failed Response

Code	Common Message	Return Message	Description
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Project GET API (프로젝트 개별 조회)

URL

GET /api/project/:projectId

Response Description

Name	Type	Description
id	UUID	프로젝트 ID
title	STRING	프로젝트 이름
isList	BOOLEAN	목록뷰일경우 true, 칸반뷰일경우 false
sections	ARRAY	하위 섹션 데이터
section.id	UUID	섹션 ID
section.tasks	ARRAY	하위 작업 정보 Task API 참조

Response

{
    id : 1,
    title: '프로젝트 이름',
    isList: true,
    sections: 
    [
        {
            id: 1,
            tasks: 
            [
                {
                    id : 1,
                    title: '작업1',
                    dueDate: '2020-11-18',
                    createdAt: '2020-11-18T07:12:41.000Z',
                    updatedAt: '2020-11-18T07:12:41.000Z'
                    tasks: [{id: 2, title: ...},{}, ...],
                }
            ]
        }
    ]
    
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	id값이 올바르지 않습니다	프로젝트 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 작업이 아닌 경우 발생합니다.
404	Not Found	해당 작업이 존재하지 않습니다.	존재하지 않는 프로젝트 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Project Post API

URL

POST /api/project

Request Description

Name	Required	Type	Description
title	REQUIRED	STRING	프로젝트 이름
isList	REQUIRED	BOOLEAN	목록뷰: true, 칸반뷰: false
isFavorite	CONDITIONAL (default=false)	BOOLEAN	즐겨찾기에 추가 여부

Request

{
    title : '프로젝트 이름',
    isList: true || false,
    color: '#111111',
    isFavorite : true || false,
}

Response Description

Name	Type	Description
message	STRING	요청 성공시 'OK'

Response

{
    message: 'ok',
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	title값이 올바르지 않습니다	타이틀이 String 타입이 아니거나 빈 문자열인 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Project Patch API

URL

PATCH /api/project/:projectID

Request Description

Name	Required	Type	Description
title	OPTIONAL	STRING	프로젝트 이름
color	OPTIONAL	STRING	프로젝트 색상
isList	OPTIONAL	Boolean	프로젝트 목록형 여부
isFavorite	OPTIONAL	Boolean	프로젝트 즐겨찾기 여부

Request

{
    title : '새로운 프로젝트 이름', 
}

Response Description

Name	Type	Description
message	STRING	요청 성공시 'OK'

Response

{
    message: 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	id값이 올바르지 않습니다	프로젝트 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
		isList값이 올바르지 않습니다	isList이 Boolean 타입이 아닌 경우 발생합니다.
		color값이 올바르지 않습니다	color 값이 String 타입이 아니거나 hexa code가 아닌 경우 발생합니다.
		isFavorite값이 올바르지 않습니다	isFavorite이 Boolean 타입이 아닌 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 프로젝트가 아닌 경우 발생합니다.
404	Not Found	존재하지 않는 작업입니다.	존재하지 않는 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Project Put API

URL

PUT /api/project/projectId

Request Description

Name	Required	Type	Description
title	REQUIRED	STRING	프로젝트 이름
color	OPTIONAL	STRING	프로젝트 색상
isList	REQUIRED	BOOLEAN	목록뷰: true, 칸반뷰: false
isFavorite	CONDITIONAL (default=false)	BOOLEAN	즐겨찾기에 추가 여부

Request

{
    title : '프로젝트 이름',
    isList: false,
    color: "#eeeeee"
    isFavorite : true || false
}

Response Description

Name	Type	Description
message	STRING	요청 성공시 'OK'

Response

{
    message: 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	id값이 올바르지 않습니다	프로젝트 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
		isList값이 올바르지 않습니다	isList이 Boolean 타입이 아닌 경우 발생합니다.
		color값이 올바르지 않습니다	color 값이 String 타입이 아니거나 hexa code가 아닌 경우 발생합니다.
		isFavorite값이 올바르지 않습니다	isFavorite이 Boolean 타입이 아닌 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 프로젝트가 아닌 경우 발생합니다.
404	Not Found	존재하지 않는 작업입니다.	존재하지 않는 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Project Delete API

URL

DELETE /api/project/:projectId

Response

{
    message: 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	id값이 올바르지 않습니다	프로젝트 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 프로젝트가 아닌 경우 발생합니다.
404	Not Found	존재하지 않는 작업입니다.	존재하지 않는 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Project - Section POST API

URL

POST /api/project/:projectId/section

Request Description

Name	Required	Type	Description
title	REQUIRED	STRING	섹션 이름

Request

{
    title : '새로운 섹션 이름', 
}

Response

{
    message: 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	id값이 올바르지 않습니다	projectId가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
		title값이 올바르지 않습니다	타이틀이 String 타입이 아니거나 빈 문자열인 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 프로젝트가 아닌 경우 발생합니다.
404	Not Found	존재하지 않는 작업입니다.	존재하지 않는 projectId인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Project - Section PATCH API

URL

PATCH /api/project/:projectId/section/:sectionId

Request Description

Name	Required	Type	Description
title	REQUIRED	STRING	섹션 이름

Request

{
    title : '새로운 섹션 이름', 
}

Response

{
    message: 'ok'
}

Failed Response

Code	Common Message	Return Message	Description
400	Bad Request	id값이 올바르지 않습니다	프로젝트 ID가 String 타입이 아니거나 UUID4 값이 아닌 경우 발생합니다.
		title값이 올바르지 않습니다	타이틀이 String 타입이 아니거나 빈 문자열인 경우 발생합니다.
401	Unauthorized	Unauthorized	유효한 토큰을 header에 포함하지 않은 경우 발생합니다.
403	Forbidden	Forbidden	해당 유저의 프로젝트가 아닌 경우 발생합니다.
404	Not Found	존재하지 않는 작업입니다.	존재하지 않는 id인 경우 발생합니다.
500	Internal Server Error	Internal Server Error	서버에 문제가 생긴 경우 발생합니다.

Project - Section Position PATCH API

URL

PATCH /api/project/:projectId/section/:sectionId/position

Request Description

Name	Required	Type	Description
orderedTasks	REQUIRED	ARRAY	화면에 보여질 순서대로 정렬된 task id 배열

Request

{
    orderedTasks : [uuid1, uuid2, uuid3, ...]
}

Response

{
    message: 'ok'
}

Project - Section DELETE API

URL

DELETE /api/project/:projectId/section/:sectionId

Response

{
    message: 'ok'
}