Search
Duplicate

API 명세

Search
Domain
Description
Method
URL
Request
Response
권한
구현
restdocs
유저
인증 이메일 전송
POST
/api/v1/users/signup/email
Open
email: email
{}
인증 이메일 확인
GET
/api/v1/user/signup/email/check?email=email&authCode=authCode
Open
x
email: email
회원가입
POST
/api/v1/users/signup
Open
username: username, email: email, password: password
{}
로그인
POST
/api/v1/users/login
Open
username: username password: password
{}
로그아웃
POST
/api/v1/users/logout
Open
x
{}
프로필 조회
GET
/api/v1/users/{userId}
Open
x
userId: userId, username: username, email: email, introduce: introduce, profileImageUrl: profileImageUrl
프로필 수정
PATCH
/api/v1/users
Open
preUsername: preUsername, username: username, introduce: introduce, password: password, image: image
{}
username 중복 확인
POST
/api/v1/users/username
Open
username: username
isDuplicated: isDuplicated
패스워드 일치 확인
POST
/api/v1/users/password/verify
Open
password: password
isMatched: isMatched
소셜 로그인
GET
/login/oauth2/code/{provider-type}
Open
팀
팀 생성
POST
/api/v1/teams
Open
name: name, description: description, color: color
teamId: teamId
팀 조회
GET
/api/v1/teams/{teamId}
Open
x
name: name, description: description, color: color, List: [ username: username, role: role ]
팀 삭제
DELETE
/api/v1/teams
Open
teamId: teamId
{}
팀 수정
PATCH
/api/v1/teams
Open
teamId: teamId, name: name
{}
멤버 초대
POST
/api/v1/teams/members
Open
teamId: teamId, List: [ username: username ]
{}
멤버 삭제
DELETE
/api/v1/teams/members
Open
teamId: teamId, username: username
{}
카테고리
카테고리 생성
POST
/api/v1/categories
Open
teamId: teamId, name: name
categoryId: categoryId
카테고리 전체 조회
GET
/api/v1/teams/{teamId}/categories/isDeleted=false
Open
x
List: [ name: name, sequence: sequence, List: [ name: name, sequence: sequenece ] ]
카테고리 삭제
DELETE
/api/v1/categories
Open
categoyId: categoryId
{}
카테고리 복구
PATCH
/api/v1/categories/restore
Open
categoryId: categoryId
{}
카테고리 수정
PATCH
/api/v1/categories
Open
name: name
{}
카테고리 순서 변경
PATCH
/api/v1/categories/order
Open
-보류
{}
카드
카드 생성
POST
/api/v1/cards
Open
categoryId: categoryId, name: name, description: desc, deadline: deadline, multipartFile: multipartFile
cardId: cardId
카드 단건 조회
GET
/api/v1/cards/{cardId}
Open
x
name: name, description: description, fileUrl: fileUrl, deadLine: deadLine, List: [ title: title List: [ content: content, isCompleted: isCompleted ] ]
카드 수정
PATCH
/api/v1/cards
Open
cardId: cardId, name: name, description: description, deadline: deadilne, file: file
{}
카드 삭제
DELETE
/api/v1/cards
Open
cardId: cardId
{}
카드 순서 변경
PATCH
/api/v1/cards/order
Open
-보류
{}
작업자
작업자 할당
POST
/api/v1/workers
Open
cardId: cardId, List: [ userId: userId ]
{}
작업자 제외
DELETE
/api/v1/workers
Open
cardId: cardId
{}
체크리스트
체크리스트 생성
POST
/api/v1/checklists
Open
title: title
checklistId: checklistId
체크리스트 수정
PATCH
/api/v1/checklists
Open
checklistId: checklistId title: title
{}
체크리스트 삭제
DELETE
/api/v1/checklists
Open
checklistId: checklistId
{}
할일
할일 생성
POST
/api/v1/tasks
Open
content: content
taskId: taskId
할일 수정
PATCH
/api/v1/tasks
Open
taskId: taskId content: content isCompleted: isCompleted
{}
할일 삭제
DELETE
/api/v1/tasks
Open
taskId: taskId
{}
댓글
댓글 생성
POST
/api/v1/comments
Open
content: content
commentId: commentId
댓글 삭제
DELETE
/api/v1/comments
Open
commentId: commentId
{}
댓글 수정
PATCH
/api/v1/comments
Open
commentId: commentId content: content
{}