| 기능 | API URL | Method | Request Header | Request | Response Boby | Response Header |
|---|---|---|---|---|---|---|
| ==Auth API== | /api/auth | |||||
| 회원가입 | /signup | POST | { | |||
| username:{username1}, | ||||||
| email:{email@naver.com}, | ||||||
| password:{password1}, | ||||||
| password:{password1} | ||||||
| } | ||||||
| 로그인 | /signin | POST | { | |||
| "username" : "username1", | ||||||
| "password" : "password1” | ||||||
| } | { | |||||
| "Authorization" : Bearer ~ | ||||||
| } | ||||||
| 로그아웃 | /signout | POST | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | ||||||
| 프로필 | ||||||
| ==Profile API== | /api/profile | |||||
| 사용자 프로필조회(본인) | / | GET | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | { | |||||
| image: {image}, | ||||||
| nickname: {nickname}, | ||||||
| score: {score}, | ||||||
| tier: {tier}, | ||||||
| game: {game} | ||||||
| } | ||||||
| 사용자 프로필 조회(내 게시글 전부) | /boards | GET | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | {[ | |||||
| ”boardId”:”boardId”, | ||||||
| “nickname”:”nickname”, | ||||||
| ”boardImageUrl”:”boardImageUrl”, | ||||||
| ”content”: “content” | ||||||
| ]} | ||||||
| 사용자 프로필 조회(내 매칭) | /matchings | GET | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | { | |||||
| ”playMode”: ”HARD”, | ||||||
| ”game”: “LOL”, | ||||||
| ”memberNumbers”: 3, | ||||||
| ”members”: [{”memberImg”: “memberImg2”, | ||||||
| ”nickname”: ”nickname1”}, | ||||||
| {”memberImg”: “memberImg3”, | ||||||
| ”nickname”: ”nickname4”}] | ||||||
| } | ||||||
| 사용자 프로필 조회(친구목록) | /buddy | GET | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | { | |||||
| ”BuddyList”: | ||||||
| [{”memberImg”: “memberImg3”, | ||||||
| ”nickname”: ”nickname2”}, | ||||||
| {”memberImg”: “memberImg5”, | ||||||
| ”nickname”: ”nickname5”}, | ||||||
| … | ||||||
| ]} | ||||||
| 사용자 프로필 조회(친구신청목록) | /notyetbuddy | GET | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | { | |||||
| ”notYetBuddy”: | ||||||
| [{”memberImg”: “memberImg2”, | ||||||
| ”nickname”: ”nickname1”}, | ||||||
| {”memberImg”: “memberImg3”, | ||||||
| ”nickname”: ”nickname4”}, | ||||||
| … | ||||||
| ]} | ||||||
| 사용자 프로필 관리 | / | PATCH | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | { | |||||
| image: {new_image}, | ||||||
| nickname: {new_nickname}, | ||||||
| score: {new_score}, | ||||||
| tier: {new_tier}, | ||||||
| game: {new_game} | ||||||
| } | {”statusCode”:200, | |||||
| ”data”:”success”} | ||||||
| 사용자 프로필 조회(타인) | /{userId} | GET | { | |||
| “image”: “image”, | ||||||
| “nickname”: “nickname”, | ||||||
| “score”: “score”, | ||||||
| “tier”: “tier”, | ||||||
| “game”: “game” | ||||||
| } | ||||||
| 친구 요청 | /notYetBuddies/{userId} |
PATCH | ||||
| 친구 요청 수락/거절 | /notYetBuddies |
POST | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | { | |||||
| “requestMemberId”: 1, | ||||||
| “answer”:true | ||||||
| } | {”statusCode”:200, | |||||
| ”data”:”success”} | ||||||
| 친구 삭제 | /buddies/{userId} | DELETE | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | {”statusCode”:200, | |||||
| ”data”:”success”} | ||||||
| 게시판 | ||||||
| ==Boards API== | /api/boards | |||||
| 일반 게시판 조회 | /normal | GET | [{ | |||
| ”id”: 1, | ||||||
| ”memberId”:1, | ||||||
| ”nickname”: “nickname1”, | ||||||
| ”memberImage”:”image.png”, | ||||||
| ”boardImage”:”image2.png”, | ||||||
| ”content”:”content1”, | ||||||
| ”createAt”:”2023-03-07T23:59:34.164813”, | ||||||
| ”modifiedAt”:”2023-03-07T23:59:34.164813” | ||||||
| }, | ||||||
| {…}, … ] | ||||||
| 일반 게시판 작성 | /normal | POST | { | |||
| "Authorization" : Bearer ~ | ||||||
| } | { |
“boardImageUrl”:”boardImageUrl”,
"content": "content1"
}
| | |
| 일반 게시판 수정 | /normal | PATCH | {
"Authorization" : Bearer ~
} | {
“boardImageUrl”:”boardImageUrl”,
"content": "content1"
} | | |
| 일반 게시판 삭제 | /normal | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”게시글 삭제완료”} | |
| 일반 게시판 조회(단건) | /normal/{boardId} | GET | | | {
”id”: 1,
”memberId”:1,
”nickname”: “nickname1”,
”memberImage”:”image.png”,
”boardImage”:”image2.png”,
”content”:”content1”,
”createAt”:”2023-03-07T23:59:34.164813”,
”modifiedAt”:”2023-03-07T23:59:34.164813”
} | |
| 익명 게시판 조회 | /anonymous | GET | | | [{
”id”: 1,
”memberId”:1,
”nickname”: “nickname1”,
”memberImage”:”image.png”,
”boardImage”:”image2.png”,
”content”:”content1”,
”likeCount”:1,
”createAt”:”2023-03-07T23:59:34.164813”,
”modifiedAt”:”2023-03-07T23:59:34.164813”
},
{…}, … ] | |
| 익명 게시판 작성 | /anonymous | POST | {
"Authorization" : Bearer ~
} | {
“boardImageUrl”:”boardImageUrl”,
"content": "content1"
} | | |
| 익명 게시판 수정 | /anonymous | PATCH | {
"Authorization" : Bearer ~
} | {
“boardImageUrl”:”boardImageUrl”,
"content": "content1"
} | | |
| 익명 게시판 삭제 | /anonymous | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”게시글 삭제완료”} | |
| 익명 게시판 조회(단건) | /anonymous/{boardId} | GET | | | {
”id”: 1,
”nickname”: “nickname1”,
”boardImage”:”image2.png”,
”content”:”content1”,
”likeCount”:1,
”createAt”:”2023-03-07T23:59:34.164813”,
”modifiedAt”:”2023-03-07T23:59:34.164813”
} | |
| 좋아요 | | | | | | |
| ==Like API== | /api/like | | | | | |
| 좋아요 등록/취소 | /{boardId} | POST | | {
"Authorization" : Bearer ~
} | {
{”body”:”좋아요”,”statusCode”:200”},
{”body”:”좋아요 취소”,”statusCode”:200}
} | |
| 익명 좋아요 등록/취소 | /{boardId} | POST | | {
"Authorization" : Bearer ~
} | {
{”body”:”좋아요”,”statusCode”:200”},
{”body”:”좋아요 취소”,”statusCode”:200}
} | |
| 댓글 | | | | | | |
| ==Comment API== | /api/comment | | | | | |
| 댓글 조회 | /{boardId} | GET | | | [{
”id”: 1,
”nickname”: “nickname1”,
”content”:”content1”,
”createAt”:”2023-03-07T23:59:34.164813”,
”modifiedAt”:”2023-03-07T23:59:34.164813”
},
{…}, … ] | |
| 댓글 작성 | /{boardId} | POST | {
"Authorization" : Bearer ~
} | {
"content" : "content1"
} | | |
| 댓글 수정 | /{commentId} | PUT | {
"Authorization" : Bearer ~
} | {
"content" : "content2"
} | | |
| 댓글 삭제 | /{commentId} | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”댓글 삭제완료”} | |
| 댓글 조회(단건) | /one/{commentId} | GET | | | {
”id”: 1,
”nickname”: “nickname1”,
”memberImage”: “image.png”,
”content”:”content1”,
”createAt”:”2023-03-07T23:59:34.164813”,
”modifiedAt”:”2023-03-07T23:59:34.164813”
} | |
| 익명 댓글 조회 | /anonymous/{boardId} | GET | | | [{
”id”: 1,
”nickname”: “nickname1”,
”content”:”content1”,
”createAt”:”2023-03-07T23:59:34.164813”,
”modifiedAt”:”2023-03-07T23:59:34.164813”
},
{…}, … ] | |
| 익명 댓글 작성 | /anonymous/{boardId} | POST | {
"Authorization" : Bearer ~
} | {
"content" : "content1"
} | | |
| 익명 댓글 수정 | /anonymous/{commentId} | PUT | {
"Authorization" : Bearer ~
} | {
"content" : "content2"
} | | |
| 익명 댓글 삭제 | /anonymous/{commentId} | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”댓글 삭제완료”} | |
| 익명 댓글 조회(단건) | /anonymous/one/{commentId} | GET | | | {
”id”: 1,
”nickname”: “nickname1”,
”memberImage”: “image.png”,
”content”:”content1”,
”createAt”:”2023-03-07T23:59:34.164813”,
”modifiedAt”:”2023-03-07T23:59:34.164813”
} | |
| 매칭 | | | | | | |
| ==Matching API== | /api/matching | | | | | |
| 매칭 신청 | / | POST | {
"Authorization" : Bearer ~
} | {
"playModeEnum" : "HARD",
”game”: “LOL”,
”memberNumbers”: 3
} | | |
| 매칭 수락 | /accept | POST | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”평가가 완료되었습니다.”} | |
| 매칭 거절 | /reject | POST | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”평가가 완료되었습니다.”} | |
| 매너 | | | | | | |
| ==Manner API== | /api/mannerPonits | | | | | |
| 매너점수 평가 (2인 매칭) | /evaluation/matching2 | POST | {
"Authorization" : Bearer ~
} | {
“matchingId”: 1,
”targetId”: 1,
”,
”upDown”: “UP”
} | {”statusCode”:200,
”data”:”success”} | |
| 매너점수 평가 (5인 매칭) | /evaluation/matching5 | POST | {
"Authorization" : Bearer ~
} | {
”matchingId”:1,
”request”: [
{
”targetId”: 1,
”,
”upDown”: “UP”
},
…]
} | {”statusCode”:200,
”data”:”success”} | |
| 채팅 | | | | | | |
| 채팅 송수신 | /chat/message | Message | {
"Authorization" : Bearer ~
} | | | |
| ==Chatting API== | /api/chat | | | | | |
| 친구 목록 불러오기 | /friends | GET | {
"Authorization" : Bearer ~
} | | [{
”nickname”: ”aa”,
”profileImage”: “”,
”tier”: “Diamond”,
”game”: “LOL”,
”mannerPoint”: 30,
”email”: “aa@aa.aa”
},
{…}, … ] | |
| 채팅방 정보 조회 및 생성 | /room/enter/{friendNick} | GET | {
"Authorization" : Bearer ~
} | | {
”id”: 1,
”roomName”: “aa-bb”,
”nickNameA”: “aa”,
”nickNameB”:”bb”
} | |
| 이전 채팅 기록 조회 | /room/{roomId}/message | GET | {
"Authorization" : Bearer ~
} | | [{
”id”: 1,
”roomId”: “1”,
”message”: “hello”,
”receiver”:”bb”
},
{
”id”: 2,
”roomId”: “1”,
”message”: “im aa”,
”receiver”:”bb”
},
…] | |
| 관리자 | | | | | | |
| ==Admin API== | /api/admin | | | | | |
| 모든 사용자 조회 | /members | GET | {
"Authorization" : Bearer ~
} | | {
[{
“nickname”:”nickname1”,
“email”
:”email@naver.com”,
”image”:”/images/…”,
},
…]
} | |
| 모든 게시글 조회 | /boards | GET | {
"Authorization" : Bearer ~
} | | {
[{
”id”: 1,
”nickname”: “nickname1”,
”boardImage”:”image2.png”,
”content”:”content1”,
”likeCount”:1,
”createAt”:”2023-03-07T23:59:34.164813”},
…]
} | |
| 모든 익명 게시글 조회 | /anonymousBoards | GET | {
"Authorization" : Bearer ~
} | | {
[{
”id”: 1,
”nickname”: “nickname1”,
”boardImage”:”image2.png”,
”content”:”content1”,
”likeCount”:1,
”createAt”:”2023-03-07T23:59:34.164813”},
…]
} | |
| 게시글에 있는 댓글 조회 | /boards/{boardId}/comments | GET | {
"Authorization" : Bearer ~
} | | {
[{”id”: 1,
”nickname”: “nickname1”,
”content”:”content1”,
”createAt”:”2023-03-07T23:59:34.164813”
},
…]
}
| |
| 익명 게시글에 있는 댓글 조회 | /anonymousBoards/{boardId}/AnonymousComments | GET | {
"Authorization" : Bearer ~
} | | {
[{”id”: 1,
”nickname”: “nickname1”,
”content”:”content1”,
”createAt”:”2023-03-07T23:59:34.164813”
},
…]
} | |
| 유저 삭제 | /members/{memberId} | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”유저가 삭제되었습니다.”} | |
| 게시글 삭제 | /boards/{boardId} | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”게시글이 삭제되었습니다.”} | |
| 익명 게시글 삭제 | /anonymousBoards/{boardId} | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”게시글이 삭제되었습니다.”} | |
| 댓글 삭제 | /comments/{commentId} | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”댓글이 삭제되었습니다.”} | |
| 익명 댓글 삭제 | /anonymousComments/{commentId} | DELETE | {
"Authorization" : Bearer ~
} | | {”statusCode”:200,
”body”:”댓글이 삭제되었습니다.”} | |