API 명세😍

유진

완료

필수

유저

회원 가입

Open

POST

/api/users/signup

{ "email" : “email@email.com", "username" : "유저네임", "password" : "password", "confirmPassword" : “password” }

{ "message" : "회원가입 성공" }

username : 한글, 영어, 숫자 (1~50자) email : ^(?:\w+\.?)*\w+@(?:\w+\.)+\w (7~50자) password : ^[a-zA-Z0-9]+$ (8~15자)

완료

필수

유저

로그인

Open

POST

/api/users/login

{ "email" : “email@email.com", "password" : "password" }

{ "message" : "로그인 성공" }

{ "Authorization": Bearer tokenvalue }

완료

필수

유저

로그아웃

Open

GET

/api/users/logout

-

{ "message" : "로그아웃 성공" }

{ "Authorization": Bearer tokenvalue }

완료

1순위

유저

카카오 소셜 로그인 (OAuth2)

Open

GET

/api/users/login/kakao/callback

-

{ "message" : "카카오 로그인 성공" }

완료

2순위

유저

회원 탈퇴

Open

POST

/api/users/withdrawal

{ "password" : "password" }

{ "message" : "회원 탈퇴 성공" }

{ "Authorization": Bearer tokenvalue }

완료

필수

유저

내 프로필 수정

Open

PATCH

/api/users/update

{ "email" : “email@email.com", "username" : "유저네임" "oldPassword" : "이전 비밀번호", "newPassword" : "새 비밀번호", ”confirmPassword” : “새 비밀번호” }

{ "message" : "사용자 정보 수정 성공" }

{ "Authorization": Bearer tokenvalue }

완료

2순위

유저

내 프로필 조회

Open

GET

/api/users/profile

-

{ "success": true, "httpStatus": "OK", "errorMessages": null, "data": { "username": "username", "email": “email@email.com" } }

{ "Authorization": Bearer tokenvalue }

완료

2순위

유저

다른 유저 프로필 조회

Open

GET

/api/users/profile/{otherUserId}

-

{ "success": true, "httpStatus": "OK", "errorMessages": null, "data": { "username": "username" } }

{ "Authorization": Bearer tokenvalue }

준혁

완료

필수

모임

모임 생성

Open

POST

/api/clubs

{ ”groupName" : "그룹명", "groupDescription" : "설명", ”groupCategory” : “카테고리”, }

{ ”groupName" : "그룹명", "groupDescription" : "설명", ”groupCategory” : “카테고리”, "createdAt" : "2024/01/04 12:53PM", "modifiedAt" : "2024/01/04 12:53PM" }

완료

필수

모임

모임 조회(v)

Open

GET

/api/clubs

{ ”page”:1, ”totalCount”:20, “data” : [ { "groupId": 1, ”groupName" : "그룹명", "groupDescription" : "설명", ”groupCategory” : “카테고리”, }, { ”page”:1, ”totalCount”:20, "groupId": 2, ”groupName" : "그룹명", "groupDescription" : "설명", ”groupCategory” : “카테고리”, } ] }

완료

필수

모임

모임 단 건 조회

Open

GET

/api/clubs/{clubId}

{ "groupId": 1 ”groupName" : "그룹명", "groupDescription" : "설명", ”groupCategory” : “카테고리”, }

완료

필수

모임

모임 가입

Open

POST

/api/clubs/{clubId}

{ “username”: “유저네임”, “email”:”email@email.com” }

{ "message" : "모임 가입 성공" }

완료

필수

모임

모임 삭제

Open

DELETE

/api/clubs/{clubId}

{ "message" : "모임 삭제 성공" }

완료

1순위

모임

모임 관리

Open

PATCH

/api/clubs/{clubId}

{ ”groupName" : "그룹명", "groupDescription" : "설명", ”groupCategory” : “카테고리”, }

{ "message" : "모임 정보 변경 성공" }

완료

1순위

모임

회원 탈퇴

Open

DELETE

/api/clubs/{clubId}

{ “message” : “회원 탈퇴 성공” }

완료

1순위

모임

모임 카테고리 설정

Open

PATCH

/api/clubs/{clubId}/category

{ ”groupCategory” : “카테고리” }

완료

2순위

모임

이메일 초대

Open

PATCH

/api/clubs/{clubId}/email

{ “email”:”email@email.com” }

한준

완료

필수

게시글

게시글 생성

Open

POST

/api/clubs/{clubId}/posts

{ “postTitle” : “제목” “postContent” : “내용” ”imageUrl” : "myfolder/img.jpg” }

{ “postTitle” : ”제목”, “postContent” : “내용”, ”imageUrl” : "myfolder/img.jpg” ”viewCount”: 0, "createdAt" : "2024/01/04 12:53PM", "modifiedAt" : "2024/01/04 12:53PM" }

완료

필수

게시글

게시글 단일 조회

Open

GET

/api/clubs/{clubId}/posts/{postId}

{ “postTitle” : “제목” “postContent” : “내용” ”imageUrl” : "myfolder/img.jpg”, ”viewCount”: 1, "createdAt" : "2024/01/04 12:53PM", "modifiedAt" : "2024/01/04 12:53PM" }

완료

필수

게시글

게시글 목록 조회(v)

Open

GET

/api/clubs/{clubId}/posts?page=1&size=5

{ “page” : 1, “size” : 10 }

{ ”page”:1, ”totalCount”:20, “data” : [ { ”postTitle" : "제목", ”imageUrl” : "myfolder/img.jpg”, ”viewCount”: 1, "createdAt" : "2024/01/04 12:53PM", "modifiedAt" : "2024/01/04 12:53PM" }, { ”postTitle" : "제목", ”imageUrl” : "myfolder/img.jpg”, ”viewCount”:1, "createdAt" : "2024/01/04 12:53PM", "modifiedAt" : "2024/01/04 12:53PM" }, ] }

완료

필수

게시글

게시글 수정

Open

PATCH

/api/clubs/{clubId}/posts/{postId}

{ “postTitle” : “제목” “postContent” : “내용” ”imageUrl” : "myfolder/img.jpg” }

{ "message" : "게시글 수정 완료" }

완료

필수

게시글

게시글 삭제

Open

DELETE

/api/clubs/{clubId}/posts/{postId}

{ “message” : “게시글 삭제 완료” }

완료

2순위

게시글

게시글 좋아요

Open

POST

/api/clubs/{clubId}/posts/{postId}/like

{ “message” : “게시글 좋아요 완료” }

완료

2순위

게시글

게시글 좋아요 취소

Open

DELETE

/api/clubs/{clubId}/posts/{postId}/like

{ “message” : “게시글 좋아요 삭제 완료” }

효정

완료

필수

댓글 생성

Open

POST

/api/groups/{groupId}/posts/{postId}/comments

{ “comment” : ”댓글” }

{ “comment” : “댓글”, "writer" : "작성자", ”likes”:1, "createdAt" : "2024/01/04 12:53PM" }

완료

필수

댓글 조회(v)

Open

GET

/api/groups/{groupId}/posts/{postId}/comments?page=1&size=2

{ ”page”:1, ”totalCount”:20, “data” : [ { “comment” : “댓글”, "writer" : "작성자", ”likes”:1, "createdAt" : "2024/01/04 12:53PM" }, { “comment” : “댓글” , "writer" : "작성자", ”likes” : 1, "createdAt" : "2024/01/04 12:53PM" } ] }

완료

필수

댓글 수정

Open

PATCH

/api/groups/{groupId}/posts/{postId}/comments/{commentId}

{ “comment” : ”댓글” }

{ “message” : “댓글 수정 완료” }

완료

필수

댓글 삭제

Open

DELETE

/api/groups/{groupId}/posts/{postId}/comments/{commentId}

{ “message” : “댓글 삭제 완료” }

완료

2순위

댓글 좋아요

Open

POST

/api/groups/{groupId}/posts/{postId}/comments/{commentId}/likes

{ “comment” : “댓글”, "username" : "작성자", ”likes”:1, "createdAt" : "2024/01/04 12:53PM" }

완료

2순위

댓글 좋아요 취소

Open

DELETE

/api/groups/{groupId}/posts/{postId}/comments/{commentId}/likes/{likeId}

{ “message” : “댓글 좋아요 삭제 완료” }

지헌

완료

필수

대댓글

대댓글 생성

Open

POST

/api/groups/{groupId}/posts/{postId}/comments/{commentId}/replies

{ “comment” : “댓글” }

완료

필수

대댓글

대댓글 조회(v)

Open

GET

/api/groups/{groupId}/posts/{postId}/comments/{commentId}/replies

{ “page” : 1, “size” : 10, “totalCount” : 100 “comment” : [ { “comment” : “댓글”, "username" : "작성자", "createdAt" : "2024/01/04 12:53PM" }, { “comment” : “댓글”, "username" : "작성자", "createdAt" : "2024/01/04 12:53PM" } ] }

완료

필수

대댓글

대댓글 수정

Open

PATCH

/api/groups/{groupId}/posts/{postId}/comments/{commentId}/replies/{replyId}

{ “comment” : “댓글” }

완료

필수

대댓글

대댓글 삭제

Open

DELETE

/api/groups/{groupId}/posts/{postId}/comments/{commentId}/replies/{replyId}

{ “message” : “대댓글 삭제 완료” }