📑9글9글9글 API

회원 관리 API

회원 가입 API

POST localhost:3000/api/signup

sentence : default value = null

deletedAt : default value = null

Request Body

Name	Type	Description
nickname*	string	닉네임
password*	string	비밀번호
email*	string	이메일
confirmPassword*	string	확인 비밀번호

201: Created 회원 가입 성공

{
message:"회원 가입에 성공하였습니다."
}

400: Bad Request 회원 가입 실패 : 중복 닉네임

{
message:"중복된 닉네임입니다."
}

400: Bad Request 회원 가입 실패 : 이메일 작성 규칙 미준수

{
message:"유효한 이메일을 입력하세요."
}

400: Bad Request 회원 가입 실패 : 비밀번호 작성 규칙 미준수

{
message:"비밀번호는 최소 8자 이상 16자 이하입니다."
}

400: Bad Request 회원 가입 실패 : 비밀번호 !== 비밀번호 확인

{
message:"비밀번호와 비밀번호 확인이 일치하지 않습니다."
}

400: Bad Request 회원 가입 실패 : 미입력

{
message:"미입력된 항목이 있습니다. 모두 입력하여 주세요."
}

400: Bad Request 회원가입 실패 : 중복 이메일을 사용할 수 없습니다.

{
message : "중복 이메일을 사용할 수 없습니다."
}

로그인 API

POST localhost:3000/api/login

Request Body

Name	Type	Description
email*	String	이메일
password*	String	비밀번호

200: OK 로그인 성공

{
message:"로그인에 성공하였습니다."
}

400: Bad Request 로그인 실패

{
message:"로그인에 실패하였습니다."
}

회원 정보 수정

POST localhost:3000/api/logout

Parmerter : userId (req.locals.user)

200: OK 로그아웃 성공

{
    message:"로그아웃에 성공하였습니다."
}

400: Bad Request 로그아웃 실패

{
    message:"로그아웃에 실패하였습니다."
}

회원 정보 수정

PATCH localhost:3000/api/profile

Parmerter : userId (req.locals.user)

Request Body

Name	Type	Description
sentence*	string	한 마디
nickname*	string	닉네임

200: OK 회원 정보 수정 성공

{
    message:"회원 정보 수정에 성공하였습니다."
}

400: Bad Request 회원 정보 수정 실패

{
    message:"회원 정보 수정에 실패하였습니다."
}

회원 정보 탈퇴

DELETE localhost:3000/api/signout

Parmerter : userId (req.locals.user)

Request Body

Name	Type	Description
deletedAt*	datetime	삭제일

200: OK 회원 정보 탈퇴 성공

{
    message:"회원 정보 탈퇴에 성공하였습니다."
}

400: Bad Request 회원 정보 탈퇴 실패

{
    message:"회원 정보 탈퇴에 실패하였습니다."
}

권한 관리 API

권한 전체 조회 API

GET localhost:3000/api/accesses

Parmerter : loginuserId (req.locals.user)

loginuserId 가 1일 때만 가능 (관리자)

400: Bad Request 권한 전체 조회 실패

{
    message:"권한 전체 조회에 실패하였습니다."
}

200: OK 권한 전체 조회 성공

{
    accesses
}

권한 생성 API

POST localhost:3000/api/accesses

Parmerter : loginuserId (req.locals.user)

해당 보드의 생성자만 권한 생성 가능

deletedAt : default value = null

Request Body

Name	Type	Description
boardId*	string	보드 Id
userId	string	회원 Id

400: Bad Request 권한 생성 실패

{
    message:"권한 생성에 실패하였습니다."
}

200: OK 권한 생성 성공

{
    message : 권한 생성에 성공하였습니다.
}

권한 삭제 API

DELETE localhost:3000/api/accesses

Parmerter : loginuserId (req.locals.user)

해당 보드의 생성자만 삭제 가능

Request Body

Name	Type	Description
boardId*	string	보드 Id
userId*	string	유저 Id
deletedAt*	datetime	삭제일

200: OK 권한 삭제 성공

{
message : “권한 삭제에 성공하였습니다.”
}

400: Bad Request 권한 삭제 실패

{
message:"권한 삭제에 실패하였습니다."
}

보드 관리 기능 API

보드 작성 API

POST localhost:3000/api/boards

Parmerter : userId (req.locals.user)

deletedAt : default value = null

Request Body

Name	Type	Description
boardName*	string	보드 이름
boardColor*	enum	보드 컬러
boardContent*	string	보드 내용

201: Created 보드 생성 성공

{
    message: "보드 생성에 성공 하셨습니다." 
}

400: Bad Request 보드 생성 삭제

{
    message: "보드 생성에 실패 하였습니다."
}

보드 전체 조회 API

GET localhost:3000/api/boards

Parmerter : userId (req.locals.user)

200: OK 보드 조회 성공 : 게시물 n개

{ boards }

200: OK 보드 조회 성공 : 게시물 0개

{
    message:"보드가 없습니다. 보드 생성을 진행해 주세요."
}

400: Bad Request 보드 조회 실패

{
    message:"보드 조회에 실패하였습니다."
}

보드 개별 조회 API

GET localhost:3000/api/boards/:boardId

Parmerter : userId (req.locals.user)

Path Parameters

Name	Type	Description
boardId	string	보드 Id

200: OK 보드 조회 성공

{ board }

400: Bad Request 보드 조회 실패

{
    message:"보드 조회에 실패하였습니다."
}

보드 수정 API

PATCH localhost:3000/api/boards/:boardId

Parmerter : userId (req.locals.user)

Path Parameters

Name	Type	Description
boardId*	string	보드 Id

Request Body

Name	Type	Description
boardName	string	보드 이름
boardColor	enum	보드 컬러
boardContent	string	보드 내용

200: OK 보드 수정 성공

{
    message:"보드 수정에 성공하였습니다."
}

400: Bad Request 보드 수정 실패

{
    message:"보드 수정에 실패하였습니다."
}

보드 삭제 API

DELETE localhost:3000/api/boards/:boardId/

Parmerter : userId (req.locals.user)

Request Body

Name	Type	Description
deletedAt	datetime	삭제일

200: OK 보드 삭제 성공

{
    message:"보드 삭제에 성공하였습니다."
}

400: Bad Request 보드 삭제 실패

{
    message:"보드 삭제에 실패하였습니다."
}

컬럼 관리 기능 API

컬럼 작성 API

POST localhost:3000/api/columns

Parmerter : userId (req.locals.user)

deletedAt : default value = null

Request Body

Name	Type	Description
boardId*	bigint	보드 Id
columnName*	string	컬럼 이름
columnOrder*	bigint	컬럼 순서

201: Created 컬럼 작성 성공

{
    message:"컬럼 작성에 성공하였습니다."
}

400: Bad Request 컬럼 작성 실패

{
    message:"컬럼 작성에 실패하였습니다."
}

컬럼 전체 조회 API

GET localhost:3000/api/columns

Parmerter : userId (req.locals.user)

Request Body

Name	Type	Description
boardId*	string	보드 Id

200: OK 컬럼조회 성공 : n개

{
    columns
}

200: OK 컬럼 조회 성공 : 0개

{
    message:"컬럼이 없습니다. 첫 작성자가 되어 주세요."
}

400: Bad Request 컬럼 조회 실패

{
    message:"컬럼 조회에 실패하였습니다."
}

컬럼 수정 API

PATCH localhost:3000/api/columns/:columnId

Parmerter : userId (req.locals.user)

Request Body

Name	Type	Description
columnName*	string	컬럼 이름

200: OK 컬럼 수정 성공

{
    message:"컬럼 수정에 성공하였습니다."
}

400: Bad Request 컬럼 수정 실패

{
    message:"컬럼 수정에 실패하였습니다."
}

컬럼 삭제 API

DELETE localhost:3000/api/columns/:columnId

Parmerter : userId (req.locals.user)

Request Body

Name	Type	Description
deletedAt*	datetime	삭제일

200: OK 컬럼 삭제 성공

{
    message:"컬럼 삭제에 성공하였습니다."
}

400: Bad Request 컬럼 삭제 실패

{
    message:"컬럼 삭제에 실패하였습니다."
}

컬럼 순서 up API

PATCH localhost:3000/api/columns/:columnId/up

Parmerter : userId (req.locals.user)

200: OK 컬럼 순서 수정 성공

{
    message:"컬럼 순서 수정에 성공하였습니다."
}

400: Bad Request 컬럼 순서 수정 실패

{
    message:"컬럼 순서 수정에 실패하였습니다."
}

컬럼 순서 down API

PATCH localhost:3000/api/columns/:columnId/down

Parmerter : userId (req.locals.user)

200: OK 컬럼 순서 수정 성공

{
    message:"컬럼 순서 수정에 성공하였습니다."
}

400: Bad Request 컬럼 순서 수정 실패

{
    message:"컬럼 순서 수정에 실패하였습니다."
}

카드 관리 기능 API

카드 작성

POST localhost:3000/api/cards

Parmerter : userId (req.locals.user)

Request Body

Name	Type	Description
cardName*	string	카드 이름
cardColor*	enum	카드 컬러
cardContent*	string	카드 내용
cardOrder*	bigint	카드 위치 조정
endAt*	datetime	마감일
columnId*	bigint	컬럼 Id

201: Created 카드 작성 성공

{
    message:"카드 작성에 성공하였습니다."
}

400: Bad Request 카드 작성 실패

{
    message:"카드 작성에 실패하였습니다."
}

카드 개별 조회 API

GET localhost:3000/api/cards /:cardId

Parmerter : userId (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	BigInt	카드 Id

200: OK 카드 조회 성공

{
    card
}

400: Bad Request 카드 조회 실패

{
    message:"카드 조회에 실패하였습니다."

카드 수정 API

PATCH localhost:3000/api/cards/:cardId

Parmerter : user (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	Bigint	카드 Id

Request Body

Name	Type	Description
cardName*	string	카드 이름
cardColor*	enum	카드 컬러
cardContent*	string	카드 내용
cardOrder*	string	카드 위치 조정

200: OK 카드 수정 성공

{
    message:"카드 수정에 성공하였습니다."
}

400: Bad Request 카드 수정 실패

{
    message:"카드 수정에 실패하였습니다."
}

카드 삭제 API

DELETE localhost:3000/api/cards/:cardId

Parmerter : user (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	bigint	카드 Id

Request Body

Name	Type	Description
deletedAt*	datetime	삭제일

200: OK 카드 삭제 성공

{
    message:"카드 삭제에 성공하였습니다."
}

400: Bad Request 카드 삭제 실패

{
    message:"카드 삭제에 실패하였습니다."
}

카드 순서 UP API

PATCH localhost:3000/api/cards/:cardId/up

Parmerter : user (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	bigint	카드 Id

200: OK 카드 순서 수정 성공

{
    message:"카드 순서 수정에 성공하였습니다."
}

400: Bad Request 카드 순서 수정 실패

{
    message:"카드 순서 수정에 실패하였습니다."
}

카드 순서 down API

PATCH localhost:3000/api/cards/:cardId/down

Parmerter : user (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	bigint	카드 Id

200: OK 카드 순서 수정 성공

{
    message:"카드 순서 수정에 성공하였습니다."
}

400: Bad Request 카드 순서 수정 실패

{
    message:"카드 순서 수정에 실패하였습니다."
}

댓글 기능 API

댓글 작성 API

POST localhost:3000/api/cards/:cardId/comments

Parmerter : userId (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	bigint	카드 Id

Request Body

Name	Type	Description
content*	string	content of the review

201: Created 댓글 작성 성공

{
    message:"댓글 작성에 성공하였습니다."
}

400: Bad Request 댓글 작성 실패

{
    message:"댓글 작성에 실패하였습니다."
}

댓글 전체 조회 API

GET localhost:3000/api/cards/:cardId/comments

Parmerter : userId (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	bigint	카드 Id

200: OK 댓글 조회 성공 : 댓글 n개

{
    comments
}

200: OK 리뷰 조회 성공 : 댓글 0개

{
    message:"댓글이 없습니다. 첫 작성자가 되어 주세요."
}

400: Bad Request 리뷰 조회 실패

{
    message:"댓글 조회에 실패하였습니다."
}

댓글 수정 API

PATCH localhost:3000/api/cards/:cardId/comments/:commentId

Parmerter : userId (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	bigint	카드 Id
commentId*	bigint	댓글 Id

Request Body

Name	Type	Description
content*	string	댓글

200: OK 댓글 수정 성공

{
    message:"댓글 수정에 성공하였습니다."
}

400: Bad Request 댓글 수정 실패

{
    message:"댓글 수정에 실패하였습니다."
}

댓글 삭제 API

DELETE localhost:3000/api/cards/:cardId/comments/:commentId

Parmerter : userId (req.locals.user)

Path Parameters

Name	Type	Description
cardId*	bigint	카드 Id
commentId*	bigint	댓글 Id

Request Body

Name	Type	Description
deletedAt*	datetime	삭제일

200: OK 댓글 삭제 성공

{
    message:"댓글 삭제에 성공하였습니다."
}

400: Bad Request 댓글 삭제 실패

{
    message:"댓글 삭제에 실패하였습니다."
}