3조: 속쓰리조 | Notion

[ ]

<aside> ☝ S.A. 내용

</aside>

우리 팀 약속
프로젝트
일정

참쉽조 개발일정

사용하는 기술
역할분배

기능	API URL	Method	request(가져 갈 데이터)	response(서버로부터 받아올 데이터)	Response Header	Response(error)
로그인	/login	`post`	{
"loginId": "jadoo12", "password": "qwer1234"}	# 200 로그인에 성공한 경우
{ "token": "eyJhbGciO......."}		# 400 loginId 또는 password가 다른 경우
{”errorMessage” : “loginId 또는 패스워드를 확인해주세요.”}

# 409 loginId에 해당하는 user가 존재하지 않는 경우 {”errorMessage” : “존재하지 않는 계정입니다.”}

# 500 예외처리 이외의 사항 {”errorMessage” : “로그인에 실패하였습니다.”} | | 회원가입 | /signup | post | { "loginId":"jadoo12", ”username”:”jadoo”, "password": "qwer1234", "confirm": "qwer1234"} | # 201 회원가입에 성공한 경우 { "message": "회원 가입에 성공하였습니다."} | | # 412 loginId 형식 검증 {"errorMessage" : "아이디의 형식이 올바르지 않습니다.”}

# 409 중복된 loginId을 사용한 경우 {"errorMessage" : “이미 존재하는 ID 입니다."}

# 412 username형식 검증 {"errorMessage" : "닉네임의 형식이 올바르지 않습니다.”}

# 409 중복된 username을 사용한 경우 {"errorMessage" : “이미 존재하는 닉네임 입니다."}

# 412 password형식 검증 {"errorMessage" : "패스워드의 형식이 올바르지 않습니다.”}

# 412password와 username이 같은 값이 입력된 경우 {"errorMessage" : "비밀번호는 username과 같은 값이 입력될 수 없습니다."}

# 412 password와 confirm값이 다른 경우 {"errorMessage" : "입력한 비밀번호와 비밀번호 확인 값이 일치하지 않습니다."}

# 500 예외처리 이외의 사항 {"errorMessage" : "회원가입에 실패하였습니다."} | | 로그아웃 | /logout | post | - | # 200 로그아웃에 성공한 경우 { "message": "로그아웃에 성공하였습니다."} | | #500 예외처리 이외의 사항 {"errorMessage" : "로그아웃에 실패하였습니다."} | | Boards 생성 | /board | post | { “boardName” : “속쓰리조캠페인”, ”boardDesc” : “캠페인 개발일지”, ”boardColor” : “blue” } | # 201 보드생성에 성공한 경우 { "message" : "성공적으로 board를 생성하였습니다." } | | # 409 body 데이터가 정상적으로 전달되지 않는 경우 {"errorMessage" : "데이터 형식이 올바르지 않습니다."}

# 412 Name, Desc, Color의 형식이 비정상적인 경우 {"errorMessage" : "보드 양식이 올바르지 않습니다."}

# 409 해당 이름의 보드가 이미 있는 경우 {”errorMessage” : “해당 보드가 이미 존재합니다.”}

# 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 500 예외 케이스에서 처리하지 못한 에러 {"errorMessage" : "보드생성에 실패하였습니다."} | | Boards 조회 | /board | get | | # 200 Board 조회에 성공한 경우 { ”boardId”: 1, ”UserId” : 1, ”boardName”: 운동, ”boardDesc”: 하루에 해야할 운동 } | | # 403 boardID가 존재하지 않을 경우 {"errorMessage" : "작성된 보드가 없어 조회에 실패하였습니다."}

# 500 예외 케이스에서 처리하지 못한 경우 {”errorMessage” : 보드조회에 실패하였습니다.”} | | Boards 수정 | /board/:boardId | put | { ”boardName”: 이름, ”boardDesc”: 내용, } | # 200 Board변경에 성공한 경우 {
"message": "Board를 변경하였습니다." } | | # 401 Board를 변경할 권한이 존재하지 않는 경우(!BoardId) {"errorMessage" : "변경 권한이 존재하지 않습니다."}

# 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 412 boardName 데이터가 입력되지 않은 경우 {"errorMessage": “boardName을 입력해주세요."}

# 412 boardDesc 데이터가 입력되지 않은 경우 {"errorMessage": "boardDesc을 입력해주세요."}

# 400 board변경에 실패한 경우 {"errorMessage": " 정상적으로 board 변경이 되지 않았습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {"errorMessage": "변경에 실패하였습니다."} | | Boards 삭제 | /board/:boardId | delete | { ”UserId” : “1”, } | # 200 보드 삭제에 성공한 경우 { "message": "보드를 삭제하였습니다."} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 401 보드를 생성한 본인이 아닌 경우 {"errorMessage" : "보드를 삭제할 권한이 존재하지 않습니다."}

# 400 보드 삭제에 실패한 경우 {"errorMessage" : "보드삭제가 정상적으로 진행되지 않았습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {"errorMessage" : "보드삭제에 실패하였습니다."} | | Boards 초대 | /board/invite | post | { ”UserId” : “1”, ”BoardId” : “3”, } | # 200 유저 초대에 성공한 경우 { “message” : “유저 초대에 성공하였습니다.” } | | # 409 해당 유저가 존재하지 않는 경우 {”errorMessage” : “해당 유저가 존재하지 않습니다.”}

# 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “유저 초대에 실패하였습니다.”} | | 컬럼 생성 | /boards/:boardId/columns | post | {”columnName” : “TO-DO”} | # 201 컬럼 생성에 성공한 경우 { "message": "컬럼 생성에 성공하였습니다."} | | # 412 body 데이터가 정상적으로 전달되지 않는 경우 {"errorMessage" : "데이터 형식이 올바르지 않습니다."}

# 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “컬럼 생성에 실패하였습니다.”} | | 컬럼 조회 | /boards/:boardId/columns | get | - | # 200 컬럼 조회에 성공한 경우 {”message” : “컬럼 조회에 성공하였습니다.} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “컬럼 생성에 실패하였습니다.”} | | 컬럼명 수정 | /boards/:boardId/columns/:columnId | put | {"columnName” : “Doing”} | # 200 컬럼명 수정에 성공한 경우 { "message": "해당 컬럼명을 수정하였습니다."} | | # 412 body 데이터가 정상적으로 전달되지 않는 경우 {"errorMessage" : "데이터 형식이 올바르지 않습니다."}

# 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 500 예외 케이스에서 처리하지 못한 에러 {"errorMessage" : "컬럼명수정에 실패하였습니다."} | | 컬럼 삭제 | /boards/:boardId/columns/:columnId | delete | - | # 200 컬럼 삭제에 성공한 경우 { "message": "해당 컬럼을 삭제하였습니다."} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 500 예외 케이스에서 처리하지 못한 에러 {"errorMessage" : "컬럼 삭제에 실패하였습니다."} | | 컬럼 순서 이동 | /boards/:boardId/columns | put | - | # 200 컬럼 순서이동에 성공한 경우 {”message” : “컬럼 이동에 성공하였습니다.} | | # 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “컬럼 순서 이동에 실패하였습니다.”} | | 카드 생성 | /card | post | { cardId: 1, ColumnId: 1, assignee: 1, cardName: 카드이름, cardDesc: 카드내용, dueDate: 날짜 } | # 200 카드생성을 성공한 경우 { message: “카드생성에 성공하였습니다.” } | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 412 body 데이터가 정상적으로 전달되지 않는 경우 {"errorMessage" : "데이터 형식이 올바르지 않습니다."}

# 409 해당 카드가 존재하는 경우 {”errorMessage” : “이미 존재하는 카드입니다.” }

# 400 리뷰 삭제에 실패한 경우 {"errorMessage" : "작성하신 카드를 생성하는데 실패하였습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “카드생성에 실패하였습니다.”}

| | 카드 수정 | /card/:cardId | put | { cardName: “변경할 이름”, cardDesc: “변경할 설명”, dueDate: “변경할 날짜”, } | # 200 카드수정에 성공한 경우 { message: “카드수정에 성공하였습니다.” } | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 412 body 데이터가 정상적으로 전달되지 않는 경우 {"errorMessage" : "데이터 형식이 올바르지 않습니다."}

# 400 카드 수정에 실패한 경우 {"errorMessage" : "카드수정을 처리하는데 실패하였습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “카드수정에 실패하였습니다.”} | | 카드 삭제 | /card/:cardId | delete | | #200 카드삭제에 성공한 경우 {”message” : “ 카드삭제가 완료되었습니다.} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

#400 회원탈퇴에 실패한 경우 {”errorMessage” : “카드삭제를 처리하는데 실패하였습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “카드삭제에 실패하였습니다. | | 카드 이동 | /card | post | | #200 카드이동에 성공한 경우 {”message” : “ 카드이동이 완료되었습니다.} | | #400 카드이동이 실패한 경우 {”errorMessage” : “카드이동을 시도하는데 실패하였습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “카드이동에 실패하였습니다. | | 카드 댓글 달기 | /card/:cardId/comments | post | { ”commentText” : “댓글 내용” } | # 200 댓글 생성에 성공한 경우 {”message” : “댓글 생성에 성공하였습니다.”} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 412 Body 데이터가 존재하지 않는 경우 {”errorMessage” : “데이터 형식이 올바르지 않습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “댓글 생성에 실패하였습니다. | | 마감일 설정 | /card/:cardId/dueDate | post | { ”dueDate” : “23-05-07 ~ 23-06-08” } | # 200 마감일 설정에 성공한 경우 {”message” : “마감일 설정에 성공하였습니다.”} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 412 Body 데이터가 존재하지 않는 경우 {”errorMessage” : “데이터 형식이 올바르지 않습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “마감일 설정에 실패하였습니다. | | 마감일 수정 | /card/:cardId/dueDate | put | { ”dueDate” : “23-06-07 ~ 23-07-08” } | # 200 마감일 수정에 성공한 경우 {”message” : “마감일 수정에 성공하였습니다.”} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 412 Body 데이터가 존재하지 않는 경우 {”errorMessage” : “데이터 형식이 올바르지 않습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “마감일 설정에 실패하였습니다. | | 회원 정보 수정 | /user/:userId | put | { ”userName” : “sio”, ”password” : “abcd1234” } | # 200 회원정보 수정에 성공한 경우 {message : “회원정보 수정에 성공하였습니다.”} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 409 이미 존재하는 name 일 경우 {errorMessage : “이미 존재하는 name입니다.”}

# 412 Body 데이터가 존재하지 않는 경우 {”errorMessage” : “데이터 형식이 올바르지 않습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “회원정보 수정에 실패하였습니다. | | 회원 탈퇴 | /user/:userId | delete | { ”password” : “qwer1234”, } | # 200 회원탈퇴에 성공한 경우 {message : “회원탈퇴에 성공하였습니다.”} | | # 403 Cookie가 존재하지 않을 경우 {"errorMessage" : "로그인이 필요한 기능입니다."}

# 403 Cookie가 비정상적이거나 만료된 경우 {"errorMessage" : "전달된 쿠키에서 오류가 발생하였습니다."}

# 412 Body 데이터가 존재하지 않는 경우 {”errorMessage” : “데이터 형식이 올바르지 않습니다.”}

# 409 비밀번호 확인값이 일치하지 않는 경우 {”errorMessage” : “유저의 회원탈퇴 권한이 존재하지 않습니다.”}

# 500 예외 케이스에서 처리하지 못한 에러 {”errorMessage” : “회원탈퇴에 실패하였습니다. |

API
와이어프레임

ERD