API 명세

기본 보기

Table

분류

기능

method

url

요구사항

request

response-success

fail

주석

사용자

회원가입

Open

POST

/v1/users/signup

{ "username":”Rtanee", "password":"123456789", ”email” : “Rtanee@sparta.com”, }

status code: 201 { "username":”Rtanee", "password":"123456789", ”email” : “Rtanee@sparta.com”, }

1. 입력값 오류 { "msg": "허용된 username 또는 password 값이 아닙니다.", "status": 400, "fieldError": [ { "errorField": "username", "correctPoint": "\"^[a-z0-9]{4,10}$\"와 일치해야 합니다" }, { "errorField": "password", "correctPoint": "\"^[a-zA-Z0-9!@#$%^&*()-_+=<>?/\\[\\]{}|;:'\",.]{8,15}$\"와 일치해야 합니다" }, { "errorField": "introduction", "correctPoint": "크기가 1에서 30 사이여야 합니다" }, { "errorField": "email", "correctPoint": "올바른 형식의 이메일 주소여야 합니다" } ] }, 2. username 중복 { "msg": "이미 존재하는 username 입니다.", "status": 400 }, 3. 관리자 인증 실패 { "msg": "관리자 암호가 틀려 등록이 불가합니다.", "status": 400 }

비밀번호 변경

Open

PATCH

/v1/users/(userId)/password

Authorization: Bearer token

{ "currentPassword" :"123456789", "newPassword" :"123456987", "passwordCheck" :"123456987" }

status code: 204

1. 현재 비밀번호가 일치하지 않는 경우 { "msg": "비밀번호가 일치하지 않습니다. } 2. 새로운 비밀번호와 비밀번호 확인이 일치하지 않는 경우 { "msg": "비밀번호가 일치하지 않습니다. }

id,email,introduction 변경

Open

PUT

/v1/users/(userId)/profile

Authorization: Bearer token

{ ”id” : “id값” "username":"수정된 이름", "email":"수정된 이메일", "introduction":"수정된 소개" }

1. DB에 저장되어 있는 이름과 중복될 경우 { "msg": "중복된 이름입니다.", } 2. DB에 저장되어 있는 이메일과 중복될 경우 { "msg": "중복된 이메일입니다.", }

프로필조회

Open

GET

/v1/users/{userId}

Authorization: Bearer token

{ "userId" : "park", "email" : “park@email.com", “introduction" : "학생 입니다.” }

로그아웃

Open

GET

/v1/users/logout

status code: 204

1. Authorization 헤더가 없을 때 { "msg": "Cannot invoke \"String.substring(int)\" because \"bearerToken\" is null", "status": 400 }, 2. Authorization헤더가 있지만 토큰값에 “Bearer “가 없을때 { "msg": "begin 7, end 0, length 0", "status": 400 }, 3. Authorization헤더가 있지만 유효한 토큰이 아닐 때 { "msg": "해당 토큰이 존재하지 않습니다.", "status": 400 },

로그인

Open

POST

/v1/users/login

{ "name" : "park", "password" : "1234" }

status code: 204 { msg; “로그인 성공했어요! 축하드려요!” }

1. username 미일치 { "msg": "등록된 유저가 없습니다.", "status": 400 } 2. 비밀번호 미일치 { "msg": "비밀번호가 일치하지 않습니다.", "status": 400 }, 3. 중복 로그인 시도 { "msg": "이미 로그인 되어 있습니다.", "status": 400 }

보드

보드 생성

Open

POST

/v1/boards

Authorization: Bearer token

{ “title”:”title”, ”content”:”content” }

“redirect: /api/boards/{boardsId}”

선택한 보드 조회

Open

GET

/v1/boards/{boardId}

[{”post_id” : ”1”, “title” : ”title”, ”content”:”content”, "createdAt": "2023-12-05T15:29:28.790981", "modifiedAt": "2023-12-05T15:29:28.790981", ”accessCount” : “조회수 입니다”, ”comment_list": [ { ”comment_id” : “3”, ”user_id” : “유저 이름1”, ”content”:”content1”, "createdAt": "2023-11-16T15:29:28.790981", "modifiedAt": "2023-12-05T15:29:28.790981" }, { ”comment_id” : “4”, ”user_id” : “유저 이름2”, ”content”:”content2”, "createdAt": "2023-11-16T15:29:28.790981", "modifiedAt": "2023-12-05T15:29:28.790981" } ]

보드가 존재하지 않습니다.

보드 삭제

Open

DELETE

/v1/boards/{boardId}

Authorization: Bearer token

{ "msg" : "삭제 성공", "status" : "200" }

보드가 존재하지 않습니다.

보드 수정

Open

PUT

/v1/boards/{boardId}

Authorization: Bearer token

{ “title”:”title 수정”, ”content”:”content 수정” }

“redirect: /api/posts/{postId}”

보드가 존재하지 않습니다.

보드 초대

Open

GET

(v1/boards/{boardId}?users={userId}")

Authorization: Bearer token

본인이 만든 보드 조회

Open

GET

/v1/boards

Authorization: Bearer token

이메일 검증

Open

GET

/v1/boards/emailCheck

Authorization: Bearer token

204 (No Content)

보드 색상 변경

Open

PATCH

/v1/boards/{boardId}/boardColor

Authorization: Bearer token

{”backgroundColor” : ”GREEN” }

리스트

리스트 생성

Open

POST

/v1/boards/{boardsId}/columns

Authorization: Bearer token

{ “comment”:”comment” }

“redirect: /api/posts/{postId}”

보드가 존재하지 않습니다.

리스트 삭제

Open

DELETE

/v1/boards/{boardsId}/columns/{columnsId}

Authorization: Bearer token

{ "msg" : "댓글이 삭제되었습니다.", "status" : "200" }

보드가 존재하지 않습니다. 리스트가 존재하지 않습니다.

리스트 수정

Open

PUT

/v1/boards/{boardsId}/columns/{columnsId}

Authorization: Bearer token

{ “comment”:”comment” }

“redirect: /api/posts/{postId}”

보드가 존재하지 않습니다. 리스트가 존재하지 않습니다.

리스트 순서 이동

Open

POST

/v1/boards/{boardsId}/columns/{columnsId}/order/{newOrder}

Authorization: Bearer token

{ ”targetBoard”: “boardId” }

보드가 존재하지 않습니다. 리스트가 존재하지 않습니다.

리스트 조회

Open

GET

/v1/boards/{boardsId}/lists/{listsId}/lists

Authorization: Bearer token

[{ ”list_id” : “유저 이름1”, “title”:”title1”, ”content”:”content1”, "comment_list" : [ "writer" : "유저 이름1", "createdAt": "2023-11-16T15:29:28.123412" ] "createdAt": "2023-11-16T15:29:28.790981" }]

보드가 존재하지 않습니다. 리스트가 존재하지 않습니다.

카드

카드 생성

Open

POST

/v1/columns/{columnsId}/cards

Authorization: Bearer token

{ "title" : "title1" }

“redirect: /v1/users/boards/lists/{postId}/cards

카드 조회

Open

GET

/v1/columns/{columnsId}/cards/{cardsId}

Authorization: Bearer token

[{”card_id” : ”1”, “title” : ”title”, ”content”:”content”, "due_date":"2023-12", "complete":"false", "createdAt": "2023-12-05T15:29:28.790981", "modifiedAt": "2023-12-05T15:29:28.790981", ”comment_list": [ { ”comment_id” : “3”, ”user_id” : “유저 이름1”, ”content”:”content1”, "createdAt": "2023-11-16T15:29:28.790981", "modifiedAt": "2023-12-05T15:29:28.790981" }, { ”comment_id” : “4”, ”user_id” : “유저 이름2”, ”content”:”content2”, "createdAt": "2023-11-16T15:29:28.790981", "modifiedAt": "2023-12-05T15:29:28.790981" } ]

보드가 존재하지 않습니다. 리스트가 존재하지 않습니다. 카드가 존재하지 않습니다.

카드 삭제

Open

DELETE

/v1/columns/{columnsId}/cards/{cardsId}

Authorization: Bearer token

204 (No Content)

보드가 존재하지 않습니다. 리스트가 존재하지 않습니다. 카드가 존재하지 않습니다.

카드 제목 수정

Open

PATCH

/v1/columns/{columnsId}/cards/{cardsId}/cardTitle

Authorization: Bearer token

{ "title" : "changeTilte" }

[{”card_id” : ”1”, “title” : ”changeTitle”, ”content”:”changeContent”, "due_date":"2023-12", "complete":"false", "createdAt": "2023-12-05T15:29:28.790981", "modifiedAt": "2023-12-05T15:41:31.790981", ”comment_list": [ { ”comment_id” : “3”, ”user_id” : “유저 이름1”, ”content”:”content1”, "createdAt": "2023-11-16T15:29:28.790981", "modifiedAt": "2023-12-05T15:29:28.790981" }, { ”comment_id” : “4”, ”user_id” : “유저 이름2”, ”content”:”content2”, "createdAt": "2023-11-16T15:29:28.790981", "modifiedAt": "2023-12-05T15:29:28.790981" } ],200 (OK)

보드가 존재하지 않습니다. 리스트가 존재하지 않습니다. 카드가 존재하지 않습니다.

카드 내용 수정

Open

PATCH

/v1/columns/{columnsId}/cards/{cardsId}/cardContent

Authorization: Bearer token

{ "title" : "changeCardContent" }

[{”title” : “title”, “writer” : “writer”, “content” : “changeContent”, “backgroundColor” : “WHITE”, “comments : {”content” : “content”, “commentWriter” : “commentWriter”}],200 (OK)

카드 색상 수정

Open

PATCH

/v1/columns/{columnsId}/cards/{cardsId}/cardColor

Authorization: Bearer token

{ "title" : "changeCardColor" }

{”title” : “title”, “writer” : “writer”, “content” : “content”, “backgroundColor” : “RED”, “comments : {”content” : “content”, “commentWriter” : “commentWriter”}},200 (OK)