Trello API

Trello Project API명세서

GitHub - hyem00/trello: nest.js / mysqlGitHub

회원 관리 API

회원가입

POST localhost:3000/api/signup

Request Body

Name	Type	Description
email*	string	실제 이메일 형식대로 작성
password*	string	최소 4자 이상의 영문 대소문자 및 숫자로 작성
confirmPassword*	string	password와 동일하게 작성
nickname*	String	닉네임

201: Created 회원가입에 성공하였습니다.

400: Bad Request 아이디 또는 비밀번호를 입력해주세요.

400: Bad Request 회원가입에 실패하였습니다.

회원 정보 조회

GET localhost:3000/api/user/:uid

Headers

Name	Type	Description
uid*	number	유저 아이디

200: OK 회원 정보

404: Not Found 회원 정보가 없습니다.

회원 정보 수정

PUT localhost:3000/api/user/:uid

Headers

Name	Type	Description
uid*	number	유저 아이디

Request Body

Name	Type	Description
password*	string	기존 유저 비밀번호
newNickname*	string	수정할 유저 닉네임
newPassword*	string	수정할 유저 비밀번호 (최소 4자 이상의 영문 대소문자 및 숫자로 작성)

200: OK 정보 수정에 성공하였습니다.

401: Unauthorized 로그인이 필요한 기능 입니다.

400: Bad Request 정보 수정에 실패하였습니다.

404: Not Found 수정할 내용이 입력되지 않았습니다.

로그인 API

로그인

POST localhost:3000/api/login

Request Body

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

200: OK 로그인 성공하였습니다.

400: Bad Request 아이디 또는 비밀번호를 입력해주세요.

400: Bad Request 로그인 실패하였습니다.

멤버 관리 API

한 보드의 멤버 전체 조회

GET localhost:3000/api/board/:bid/member

Request Body

Name	Type	Description
bid	int

200: OK 멤버 리스트가 조회 완료 되었습니다.

400: Bad Request 멤버 조회에 실패하였습니다.

404: Not Found 해당 보드가 존재하지 않습니다

멤버 추가 기능

POST localhost:3000/api/member

보드 관리자만 사용 할 수 있는 기능

Request Body

Name	Type	Description
uid	int
bid	int

200: OK 멤버 추가에 성공하였습니다.

404: Not Found 찾을 수 없는 사용자 입니다.

401: Unauthorized 권한이 없습니다.

404: Not Found 쿠키값에 유저가 존재하지 않습니다

멤버 삭제 기능

DELETE localhost:3000/api/member/

보드 관리자만 사용 할 수 있는 기능

Cookies

Name	Type	Description
uid	int

Request Body

Name	Type	Description
bid	int

200: OK 멤버 삭제에 성공하였습니다.

404: Not Found 존재하지 않는 멤버 입니다.

401: Unauthorized 권한이 없습니다.

404: Not Found 존재하지 않는 보드입니다.

400: Bad Request 멤버 삭제에 실패하였습니다.

보드관리 API

전체 보기

GET localhost:3000/api/board/:bid

Request Body

Name	Type	Description
bid	integer	조회 될 보드아이디

200: OK 리스트 조회에 성공하였습니다.

400: Bad Request 리스트 조회에 실패하였습니다.

404: Not Found 조회 가능한 보드가 없습니다.

보드 생성

POST localhost:3000/api/board

Request Body

Name	Type	Description
boardId	integer	보드 아이디
userId	integer	유저 아이디
name	varchar	보드 이름
explanation	varchar	보드 설명
color	varchar	보드 색상

200: OK 보드 생성이 완료 되었습니다.

400: Bad Request 보드 생성에 실패하였습니다.

보드 수정

PATCH localhost:3000/api/board/:bid

Request Body

Name	Type	Description
name	varchar	보드 이름
explanation	varchar	보드 설명
color	String	보드 색상

200: OK 보드 수정이 완료 되었습니다.

400: Bad Request 보드 수정에 실패하였습니다.

보드 삭제

DELETE localhost:3000/api/board/:bid

Request Body

Name	Type	Description
boardId	integer	보드 아이디
userId	integer	유저 아이디

200: OK 보드 삭제가 완료 되었습니다.

400: Bad Request 보드 삭제에 실패하였습니다.

리스트 API

리스트 조회

GET localhost:3000/api/board/:bid/list

Request Body

Name	Type	Description
lid	number

200: OK 리스트 조회에 성공하였습니다.

400: Bad Request 리스트 조회에 실패하였습니다.

리스트 생성

POST localhost:3000/api/board/:bid/list

Request Body

Name	Type	Description
title	String	리스트 제목
content	String

200: OK 리스트가 생성되었습니다.

400: Bad Request 리스트 생성이 실패하였습니다.

리스트 수정

PATCH localhost:3000/api/board/:bid/list/:lid

Request Body

Name	Type	Description
title	String
content	String

200: OK 리스트 수정에 성공하였습니다

404: Not Found 해당하는 리스트가 존재하지 않습니다.

400: Bad Request 수정할 내용 또는 제목을 입력해주세요.

리스트 삭제

DELETE localhost:3000/api/board/:bid/list/:lid

200: OK 리스트가 삭제되었습니다.

400: Bad Request 리스트 삭제에 실패하였습니다.

카드 관리 API

카드 작성 api

POST localhost:3000/api/board/:bid/list/:lid/card

Headers

Name	Type	Description
bid*	number	보드 아이디
lid*	number	리스트아이디

Request Body

Name	Type	Description
title*	String	카드 제목
color*	String	카드 색상
manager*	String	작업자
explanation*	String	카드 설명
deadline*	String	카드 마감일

200: OK 카드가 생성되었습니다.

400: Bad Request 카드 생성에 실패하였습니다.

카드 목록 조회

GET localhost:3000/api/board/:bid/list/:lid/card

Headers

Name	Type	Description
bid	number	보드아이디
lid	number	리스트아이디

200: OK

404: Not Found 조회할 카드가 없습니다.

카드 수정

PUT localhost:3000/api/board/:bid/list/:lid/card/:cid

Headers

Name	Type	Description
bid*	number	보드아이디
lid*	number	리스트아이디
cid*	number	카드아이디

Request Body

Name	Type	Description
title*	String	수정할 카드 제목
color*	String	수정할 카드 색상
explanation*	String	수정할 카드 설명

200: OK 카드 수정에 성공하였습니다.

400: Bad Request 카드 수정에 실패하였습니다.

카드 마감일 수정

PATCH localhost:3000/api/board/:bid/list/:lid/card/:cid

Headers

Name	Type	Description
bid*	number	보드아이디
lid*	number	리스트아이디
cid*	number	카드아이디

Request Body

Name	Type	Description
deadline*	date	기존 마감일
NewDeadline*	date	수정한 마감일

200: OK 마감일 수정에 성공하였습니다

400: Bad Request 마감일 수정에 실패하였습니다

카드 삭제

DELETE localhost:3000/api/board/:bid/list/:lid

Headers

Name	Type	Description
lid*	integer	리스트 아이디

Request Body

Name	Type	Description
cid*	number	삭제할 카드 아이디

200: OK 카드가 삭제되었습니다.

404: Not Found 찾을수 없는 카드입니다.

401: Unauthorized 권한이 없습니다.

카드 매니저 API

카드 매니저 조회

GET localhost:3000/api/board/:bid/card/:cid/manager

Headers

Name	Type	Description
uid	number	유저ID
cid	number	카드ID

200: OK 매니저 조회에 성공 했습니다.

400: Bad Request 카드 조회에 실패 했습니다.

카드 매니저 추가

POST localhost:3000/api/board/:bid/card/:cid/manager

Request Body

Name	Type	Description
uid	number
cid	number

200: OK 카드 매니저 추가에 성공하였습니다.

400: Bad Request 카드 매니저 추가에 실패하였습니다.

카드 매니저 변경

PUT localhost:3000/api/board/:bid/card/:cid/manager/:uid

Request Body

Name	Type	Description
uid	number
cid	number

200: OK 카드 매니저 변경에 성공하였습니다.

400: Bad Request 카드 매니저 변경에 실패하였습니다.

카드 매니저 삭제

DELETE localhost:3000/api/board/:bid/card/:cid/manager/:uid

200: OK 카드 매니저 삭제에 성공하였습니다.

400: Bad Request 카드 매니저 삭제에 실패하였습니다.

순서 변경 API

리스트 순서 변경

POST localhost:3000/api/list/:lid/order

Request Body

Name	Type	Description
order	int

200: OK 순서 변경에 성공하였습니다.

400: Bad Request 순서 변경에 실패하였습니다.

카드 순서 변경

POST localhost:3000/api/card/:cid/order

200: OK 카드 순서 변경에 성공하였습니다.

400: Bad Request 카드 순서 변경에 실패하였습니다.

댓글 API

댓글생성

POST localhost:3000/api/board/:bid/card/:cid/comment

Path Parameters

Name	Type	Description
bid*	number	보드 아이디
cid*	number	카드 아이디

Request Body

Name	Type	Description
comment*	String	댓글

200: OK

400: Bad Request

401: Unauthorized

댓글 목록 전체 조회

GET localhost:3000/api/board/:bid/card/:cid/comment

Path Parameters

Name	Type	Description
bid*	number	보드 아이디
cid*	number	카드 아이디

200: OK

400: Bad Request

401: Unauthorized

댓글 1개 조회

GET localhost:3000/api/board/:bid/card/:cid/comment/:commentId

Path Parameters

Name	Type	Description
bid*	number	보드 아이디
cid*	number	카드 아이디
commentId*	number	댓글 아이디

200: OK

400: Bad Request

401: Unauthorized

댓글 수정

PUT localhost:3000/api/board/:bid/card/:cid/comment/:commentid

Headers

Name	Type	Description
commentid*	number	수정할 코멘트 아이디

Request Body

Name	Type	Description
comment*	String	수정할 댓글 내용

200: OK

404: Not Found 수정 내용을 입력해주세요

400: Bad Request 존재하지 않는 댓글입니다.

댓글 삭제

DELETE localhost:3000/api/board/:bid/card/:cid/comment/:commentId

200: OK 댓글이 삭제 되었습니다.

400: Bad Request 댓글이 삭제 되었습니다.