API 명세

https://docs.whenwheres.com/

Table

Search

Domain

Description

Method

URL

Request

Response

권한

구현

restdocs

유저

인증 이메일 전송

POST

/api/v1/users/signup/email

email: email

{}

인증 이메일 확인

GET

/api/v1/user/signup/email/check?email=email&authCode=authCode

x

email: email

회원가입

POST

/api/v1/users/signup

username: username, email: email, password: password

{}

로그인

POST

/api/v1/users/login

username: username password: password

{}

로그아웃

POST

/api/v1/users/logout

x

{}

프로필 조회

GET

/api/v1/users/{userId}

x

userId: userId, username: username, email: email, introduce: introduce, profileImageUrl: profileImageUrl

프로필 수정

PATCH

preUsername: preUsername, username: username, introduce: introduce, password: password, image: image

{}

username 중복 확인

POST

/api/v1/users/username

username: username

isDuplicated: isDuplicated

패스워드 일치 확인

POST

/api/v1/users/password/verify

password: password

isMatched: isMatched

소셜 로그인

GET

/login/oauth2/code/{provider-type}

팀

팀 생성

POST

name: name, description: description, color: color

teamId: teamId

팀 조회

GET

/api/v1/teams/{teamId}

x

name: name, description: description, color: color, List: [ username: username, role: role ]

팀 삭제

DELETE

teamId: teamId

{}

팀 수정

PATCH

teamId: teamId, name: name

{}

멤버 초대

POST

/api/v1/teams/members

teamId: teamId, List: [ username: username ]

{}

멤버 삭제

DELETE

/api/v1/teams/members

teamId: teamId, username: username

{}

카테고리

카테고리 생성

POST

/api/v1/categories

teamId: teamId, name: name

categoryId: categoryId

카테고리 전체 조회

GET

/api/v1/teams/{teamId}/categories/isDeleted=false

x

List: [ name: name, sequence: sequence, List: [ name: name, sequence: sequenece ] ]

카테고리 삭제

DELETE

/api/v1/categories

categoyId: categoryId

{}

카테고리 복구

PATCH

/api/v1/categories/restore

categoryId: categoryId

{}

카테고리 수정

PATCH

/api/v1/categories

name: name

{}

카테고리 순서 변경

PATCH

/api/v1/categories/order

-보류

{}

카드

카드 생성

POST

categoryId: categoryId, name: name, description: desc, deadline: deadline, multipartFile: multipartFile

cardId: cardId

카드 단건 조회

GET

/api/v1/cards/{cardId}

x

name: name, description: description, fileUrl: fileUrl, deadLine: deadLine, List: [ title: title List: [ content: content, isCompleted: isCompleted ] ]

카드 수정

PATCH

cardId: cardId, name: name, description: description, deadline: deadilne, file: file

{}

카드 삭제

DELETE

cardId: cardId

{}

카드 순서 변경

PATCH

/api/v1/cards/order

-보류

{}

작업자

작업자 할당

POST

/api/v1/workers

cardId: cardId, List: [ userId: userId ]

{}

작업자 제외

DELETE

/api/v1/workers

cardId: cardId

{}

체크리스트

체크리스트 생성

POST

/api/v1/checklists

title: title

checklistId: checklistId

체크리스트 수정

PATCH

/api/v1/checklists

checklistId: checklistId title: title

{}

체크리스트 삭제

DELETE

/api/v1/checklists

checklistId: checklistId

{}

할일

할일 생성

POST

content: content

taskId: taskId

할일 수정

PATCH

taskId: taskId content: content isCompleted: isCompleted

{}

할일 삭제

DELETE

taskId: taskId

{}

댓글

댓글 생성

POST

/api/v1/comments

content: content

commentId: commentId

댓글 삭제

DELETE

/api/v1/comments

commentId: commentId

{}

댓글 수정

PATCH

/api/v1/comments

commentId: commentId content: content

{}