API 명세서

Table

Search

구분

기능

method

URL

request

response

담당자

인증

구현

docs

유저

POST

/v1/users/signup

{ ”email”: ”이메일”, ”password”: ”비밀번호”, ”username”: ”닉네임”, ”job” : “직군” }

{ "code": 0, "message": "정상 처리 되었습니다", "data": {} }

유저

이메일인증

POST

/v1/users/email

{ ”email”: “이메일”, ”authNumber”: ”인증번호” }

{ }

유저

POST

/v1/users/login

{ ”email”: “이메일”, ”password”: “비밀번호” }

{ "code": 0, "message": "정상 처리 되었습니다", "data": { "userId": 2 } }

유저

POST

/v1/users/logout

x

{}

유저

GET

/v1/users/{id}

x

{ ”email”: “이메일”, ”username”: ”닉네임”, ”role”: ”권한”, ”job” : “직군”, ”introduce”: “소개”, ”following”: 1, ”follower”: 1, ”profileImageUrl”: ”이미지” }

유저

프로필수정

PATCH

/v1/users

{ ”password”: ”비밀번호”, ”username”: ”닉네임”, ”job” : “직군”, ”introduce”: “소개” } ”profileImageUrl”: ”이미지”

{}

유저

DELETE

/v1/users

x

{}

유저

유저팔로우

POST

/v1/users/following

{ ”following”: ”아이디” }

{}

유저

유저팔로우 취소

DELETE

/v1/users/following

{ ”following”: ”아이디” }

{}

유저

유저팔로워 목록확인

GET

/v1/users/follower/{id}

x

[ { ”userId”: “아이디”, ”username”: “닉네임”, ”profileImageUrl”: “이미지” } ]

유저

유저팔로잉 목록확인

GET

/v1/users/following/{id}

x

[ { ”userId”: ”아이디”, ”username”: “닉네임”, ”profileimageUrl”: “이미지” } ]

모집글

모집글 작성

POST

/v1/posts

{ ”title”: “title”, ”content”: “content”, ”deadline”: “2024-02-01”, ”jobLimits”: [{ ”job”: “BACKEND”, ”headcount”: 3 }], ”skills”: [”JAVA”, “SPRING”, “KOTLIN”] } ”images”: “image” (multipartfile)

{ ”postId”: 1 }

모집글

모집글 수정

PATCH

/v1/posts

{ ”postId”: 1, ”title”: “title”, ”content”: “content”, ”deadline”: “2024-02-01”, ”jobLimits”: [{ ”job”: “BACKEND”, ”headcount”: 3 }], ”skills”: [”JAVA”, “SPRING”, “KOTLIN”] } ”images”: “image” (multipartfile)

{}

모집글

모집글 삭제

DELETE

/v1/posts

{ ”postId”: 1 }

{}

모집글

모집글 단건 조회

GET

/v1/posts/{postId}

x

{ ”postId”: 1, ”title”: “title”, ”content”: “content”, ”deadline”: “2024-02-01”, ”visit”: 1, ”like”: 1, ”imageUrl”: “imageUrl”, ”status”: “inprogress”, ”username”: “username”, ”jobLimits”: [ ”job”: “BACKEND”, ”headcount”: 2 ], ”skills”: [”JAVA”, “SPRING”, “KOTLIN”], ”members”: [ ”userId”: 1, ”profileImageUrl”: “image” ] }

모집글

모집글 조건별 전체 조회

GET

/v1/posts?type={type}&skill={skill}&job={job} type - ALL - WRITE - APPLY - LIKE - MEMBER - SKILL - JOB

x

[ { ”postId”: 1, ”title”: “title”, ”content”: “content”, ”deadline”: “2024-02-01”, ”visit”: 1, ”like”: 1, ”imageUrl”: “imageUrl”, ”status”: “inprogress”, ”username”: “username”, ”jobLimits”: [ ”job”: “BACKEND”, ”headcount”: 2 ] } ]

모집글

모집글 좋아요

POST

/v1/posts/like

{ ”postId”: 1 }

{}

모집글

모집글 좋아요 취소

DELETE

/v1/posts/unlike

{ ”postId”: 1 }

{}

모집글

모집글 상태 변경

PATCH

/v1/posts/status

{ ”postId”: 1, ”status”: “inprogress” }

{}

댓글

POST

/v1/comments

{ ”postId”: 1, "content": "댓글 내용" }

{ ”commentId”: 1 }

댓글

PATCH

/v1/comments

{ ”commentId”: 1, "content": "수정된 댓글 내용" }

{}

댓글

DELETE

/v1/comments

{ ”commentId”: 1 }

{}

댓글

GET

/v1/comments/{postId}

x

[ { ”commentId” : 1, ”comment” : “댓글 내용”, ”username”: “닉네임” } ]

채팅

POST

/v1/chats

{ ”receiverId”: 1, ”content” : “메세지” }

{ ”email” : “이메일”, ”username” : “닉네임”, ”content” : “메세지” }

채팅

채팅방 생성

POST

/v1/rooms

{ ”receiverId”:1 }

채팅

채팅방 조회

GET

/v1/rooms/{room-id}

채팅

GET

/v1/chats

채팅

채팅 보내기

Message

/v1/chats/{room-id}

{ ”roomId”:1, ”senderId”:2, ”content”:”채팅” }

신청

모집글에 대한 팀원 신청

POST

/v1/applicants

{ ”postId”: 1, ”job”: “BACKEND” }

{}

신청

모집글에 대한 팀원 신청 취소

DELETE

/v1/applicants

{ ”postId”: 1 }

{}

신청

신청목록 조회

GET

/v1/applicants/{postId}

x

[ { ”userId”: 1, ”username”: “닉네임”, ”imageUrl”: “imageUrl”, ”job”: “BACKEND” } ]

팀원

POST

/v1/members

{ ”postId”: 1, ”userId”: 1, ”job”: “BACKEND” }

{}

팀원

DELETE

/v1/members

{ ”memberId”: 1, ”userId” 1 }

{}