Project(In Progress)

Create a Project

POST {{apiUrl}}/api/projects

Headers

Name	Type	Description
accessToken*	String	Authorization Token

Request Body

Name	Type	Description
form*	form-data	프로젝트 생성 정보(title, content, links, labels, startDate, endDate) - JSON
file*	form-data	이미지 파일
labels*	String[]	라벨 배열
content*	String	Project 내용
title*	String	Project 제목
links*	link[]	링크 배열
endDate*	String	Project 종료일
startDate*	String	Project 시작일

200: OK

{
  "id" : 1
}

Edit a Project

POST {{apiUrl}}/api/projects/{projectId}

Path Parameters

Name	Type	Description
projectId*	Number	Project 식별자

Headers

Name	Type	Description
accessToken*	String	Authorization Token

Request Body

Name	Type	Description
title*	String	Project 제목
file*	form-data	이미지 파일
form*	form-data	프로젝트 생성 정보(title, content, links, labels, startDate, endDate) - JSON
endDate*	String	Project 종료일
startDate*	String	Project 시작일
labels*	String[]	라벨 배열
links*	link[]	링크 배열
content*	String	Project 내용

200: OK

{
  "id" : 1
}

401: Unauthorized

Delete a Project

DELETE {{apiUrl}}/api/projects/{projectId}

Path Parameters

Name	Type	Description
projectId*	Number	Project 식별자

Headers

Name	Type	Description
accessToken*	String	Authorization Token

200: OK

{
  "id" : 1
}

401: Unauthorized

Create one Project

GET {{apiUrl}}/api/projects/{projectId}

Path Parameters

Name	Type	Description
projectId*	Number	Project 식별자

Headers

Name	Type	Description
accessToken*	String	Authorization Token

200: OK

{
  "id" : 1,
  "title" : "테스트프로젝트",
  "content" : "테스트용입니다.",
  "startDate" : "2022-11-07",
  "endDate" : "2022-11-27",
  "projectLinks" : [ {
    "id" : 1,
    "name" : "github",
    "url" : "https://github.com/Haru-Dashboard"
  }, {
    "id" : 2,
    "name" : "jira",
    "url" : "https://jira.com"
  } ],
  "projectLabels" : [ {
    "id" : 1,
    "name" : "프로젝트"
  }, {
    "id" : 2,
    "name" : "BE"
  } ],
  "imageInfo" : {
    "id" : 1,
    "originName" : "image.png",
    "name" : "image.png",
    "extension" : "png",
    "imageUrl" : "https://s3.ap-northeast-2.amazonaws.com/image.png"
  }
}

401: Unauthorized

Get user's Project list

GET {{apiUrl}}/api/projects

Query Parameters

Name	Type	Description
size	Number
page	Number

Headers

Name	Type	Description
accessToken*	String	Authorization Token

200: OK

[ {
  "id" : 1,
  "title" : "테스트프로젝트",
  "content" : "테스트용입니다.",
  "startDate" : "2022-11-07",
  "endDate" : "2022-11-27",
  "projectLinks" : [ {
    "id" : 1,
    "name" : "github",
    "url" : "https://github.com/Haru-Dashboard"
  }, {
    "id" : 2,
    "name" : "jira",
    "url" : "https://jira.com"
  } ],
  "projectLabels" : [ {
    "id" : 1,
    "name" : "프로젝트"
  }, {
    "id" : 2,
    "name" : "BE"
  } ],
  "imageInfo" : {
    "id" : 1,
    "originName" : "image.png",
    "name" : "f621a6be-b743-4d17-90ea-5906f678c36c.png",
    "extension" : "png",
    "imageUrl" : "https://s3.ap-northeast-2.amazonaws.com/image.png"
  }
}, {
  "id" : 2,
  "title" : "Haru Dashboard",
  "content" : "개발자들을 위한 크롬 확장 프로그램",
  "startDate" : "2022-10-28",
  "endDate" : "2022-11-24",
  "projectLinks" : [ {
    "id" : 3,
    "name" : "mattermost",
    "url" : "https://mattermost.com"
  }, {
    "id" : 4,
    "name" : "Haru",
    "url" : "https://haru-dashboard.com"
  } ],
  "projectLabels" : [ {
    "id" : 3,
    "name" : "토이프로젝트"
  }, {
    "id" : 4,
    "name" : "FE"
  } ],
  "imageInfo" : {
    "id" : 2,
    "originName" : "image.png",
    "name" : "c36c.png",
    "extension" : "png",
    "imageUrl" : "https://s3.ap-northeast-2.amazonaws.com/c36c.png"
  }
}, {
  "id" : 3,
  "title" : "특화 프로젝트",
  "content" : "빅데이터 분산처리 - 하둡을 이용한 유저 로그 분산처리",
  "startDate" : "2022-10-18",
  "endDate" : "2022-11-17",
  "projectLinks" : [ {
    "id" : 5,
    "name" : "UCC",
    "url" : "https://youtube.com"
  }, {
    "id" : 6,
    "name" : "docs",
    "url" : "https://haru-dashboard/docs"
  } ],
  "projectLabels" : [ {
    "id" : 5,
    "name" : "사이드프로젝트"
  }, {
    "id" : 6,
    "name" : "DevOps"
  } ],
  "imageInfo" : {
    "id" : 3,
    "originName" : "image.png",
    "name" : "906f67.png",
    "extension" : "png",
    "imageUrl" : "https://s3.ap-northeast-2.amazonaws.com/906f67.png"
  }
} ]