기능 | Method | End Point | query string | Request Body | Response Body | statusCode& exception |
---|---|---|---|---|---|---|
회원 가입 정보 보내기 | POST |
/user/signup |
{ |
”user” :
{ "userId":"kooo123", "password":"1234567", "confirmPassword":"1234567", "description":"안녕하세요!잘부탁드립니다", "name":"kooo123", "gender":"남", "age":23, "email":"[email protected]", "studentId":"20202238", "uniName":"건국대학교", "externalId":"koo123", "detailProfile":{ "height":175, "bodyType":"마름", "address":"용산구", "department":"공학계열", "firstCharacter":"시크", "secondCharacter":"이성적", "mbti":"INTJ", "smoke":"종종", "drink":"종종", "firstHobby":"복싱", "secondHobby":"축구", "drink":"종종", "smoke":"흡연 안 함", "firstPriority":"취미", "secondPriority":"체형", "thirdPriority":"나이" }, "idealTypeProfile":{ "idealAge":"20대 중반", "idealHeight":"165이상 170미만", "idealBodyType":"슬림", "idealDepartment":"공학계열", "firstIdealCharacter":"다정", "secondIdealCharacter":"이성적", "idealMbti":"ENFP", "firstIdealHobby":"등산", "secondIdealHobby":"야구", "idealDrink":"종종", "idealSmoke":"흡연 안 함" } } // form-data 처리 ”basicFilePath”: “2.amazonaws.com/sample.jpg”, ”secondFilePath”: ”2.amazonaws.com/KakaoTalk_20230129_133925128.jpg”, ”thirdFilePath”:”2.amazonaws.com/KakaoTalk_20230130_182242489_01.jpg” } |
{
"userId": "kiki123",
"name": "kiki",
"_links": {
"signup": {
"href": "http://localhost/users/signup"
}
}
} | |
| 회원 가입 화면 조회 | GET
| /user/signup
| | | | |
기능 | Method | End Point | query String | Request Body | Response Body | statusCode& exception | ||||
---|---|---|---|---|---|---|---|---|---|---|
학교 이메일로 인증 시작하기 | POST |
/users/api/sendEmail | { | |||||||
"email":"[email protected]", | ||||||||||
"uniName":"건국대학교" | ||||||||||
} | { |
"success":true
}
| | | | | |
| 학교 이메일로 보낸 인증 코드 작성해서 보내고 같은지 검증하기 | POST
| /users/api/code | | {
"code": 10261,
"email":"[email protected]",
"univName":"건국대학교"
} | {
"success": true
}
| | | | | |
기능 | Method | End Point | query string | Request Body | Response Body | statusCode& exception |
---|---|---|---|---|---|---|
로그인 화면 | GET |
/ | 200 OK | |||
로그인 | POST |
/users/login | { | |||
“userId" : “konkuk123”, |
`“password”`: “abc123”,
}
| {
“message”
: signin success
} | 301 Permanent Redirect |
| 아이디 찾기 | GET
| | | 데이터 미정 | | |
| 비밀번호 찾기 | GET
| | | 데이터 미정 | | |
| 회원가입 (화면) | GET
| | | | | 200 OK |
기능 | Method | End Point | query string | Request Body | Response Body | statusCode& exception | |
---|---|---|---|---|---|---|---|
소개팅 화면 조회 | |||||||
( 소개팅 받는 상대들 조회 ) | GET |
/blindDate/{userId}/matches |
{ | ||||
"userId": "john123", | |||||||
"name": "jhon", | |||||||
"age": 23, | |||||||
"bodyType": "슬림", | |||||||
"height":170, | |||||||
"addressType": "용산구", | |||||||
"uniName": "한양대학교", | |||||||
"departmentType": "경영대학", | |||||||
"characterType": "다정", | |||||||
"emotionType": "이성적", | |||||||
"hobby1":"여행", | |||||||
"hobby2":"헬스", | |||||||
"mbtiType": "INTJ", | |||||||
"basicFilePath": "https://imagefordugeun.s3.ap-northeast-2.amazonaws.com/sample.jpg", | |||||||
"secondFilePath": "https://imagefordugeun.s3.ap-northeast-2.amazonaws.com/KakaoTalk_20230129_133925128.jpg", | |||||||
"thirdFilePath": "https://imagefordugeun.s3.ap-northeast-2.amazonaws.com/KakaoTalk_20230130_182242489_01.jpg", | |||||||
"userIdSec": "mike123", | |||||||
"nameSec": "mike", | |||||||
"ageSec": 27, | |||||||
”heightSec”:170, | |||||||
"bodyTypeSec": "슬림", | |||||||
"addressTypeSec": "용산구", | |||||||
"uniNameSec": "건국대학교", | |||||||
"departmentTypeSec": "경영대학", | |||||||
"characterTypeSec": "다정", | |||||||
"emotionTypeSec": "이성적", | |||||||
”firstHobbySec”:"여행", | |||||||
”secondHobbySec”:"헬스", | |||||||
"mbtiTypeSec": "INTJ", | |||||||
"basicFilePathSec": "https://imagefordugeun.s3.ap-northeast-2.amazonaws.com/sample.jpg", | |||||||
"secondFilePathSec": "https://imagefordugeun.s3.ap-northeast-2.amazonaws.com/KakaoTalk_20230129_133925128.jpg", | |||||||
"thirdFilePathSec": "https://imagefordugeun.s3.ap-northeast-2.amazonaws.com/KakaoTalk_20230130_182242489_01.jpg" | |||||||
} | |||||||
“두근 보내기” 버튼 클릭 시 | POST |
/blindDate/like |
{ | ||||
”userId”:”john123”, | |||||||
”targetUserId”:”kim123” | |||||||
} | { |
"success": true
} | | |
기능 | Method | End Point | query string | Request Body | Response Body | statusCode& exception |
---|---|---|---|---|---|---|
“미팅방 페이지” 미팅방 목록 | GET |
/group |
{ | |||
{ | ||||||
} |
{”roomId”:1,
“capacityMale” : 3,
“capacityFemale” : 3,
”title”:”건전한 만남해요”,
”groupBlindIntroduction”:”안녕하세요~ ㅇㅇㅇㅇㅇ”,
“groupBlindStatus” : NOT_FULL,
“hostId” : “tommy123”,
“ “ : “true“
members:[
]
} …
} | |
| 미팅방 입장 | POST
| /group/{roomId}
| | | {
“status” :200 이면
“responseMsg” : "미팅방에 입장하였습니다"
“status” :400 이면
“responseMsg” : ”정원이 다 찼습니다.”
} | |
| 미팅방 만들기 | POST
| /group/{userId}/new
| | {
“title” : “건전한 만남해요”,
“capacityMale” : 3,
“capacityFemale” : 3,
“groupBlindIntroduction” : “안녕하세요~ ㅇㅇㅇㅇㅇ”
“groupBlindCategory” : “TWOTOTWO”
} | {
”roomId”:1,
“capacityMale” : 3,
“capacityFemale” : 3,
”title”:”건전한 만남해요”,
”groupBlindIntroduction”:”안녕하세요~ ”,
“groupBlindStatus” : NOT_FULL,
“hostId” : “tommy123”,
“createRoomNumber” : 1
} | |
| 미팅방 수정 | PUT
| /group/{roomId}/update
| | | 수정 내역 반영 | |
| 미팅방 나가기 | POST
| /group/{roomId}/exit
| | | {
// 퇴장한 유저ID
”userId”:”kiki123”
} | |
| 미팅방 시작 | POST
| /group/{roomId}/achieve
| | | participantExternalIds: [
{
"userId": "1",
"externalId": "A"
},
{
"userId": "2",
"externalId": "B"
},
{
"userId": "3",
"externalId": "C"
}
] | |
| 미팅방 삭제 | DELETE (POST)
| /group/{roomId}/delete
| |
| | |
| 미팅방 정보 | GET
| /group/{roomId}/info
| | | {
“presentMale” : 1,
“presentFemale” : 1,
”title”:”건전한 만남해요”,
”groupBlindIntroduction”:”안녕하세요~ ㅇㅇㅇㅇㅇ”,
“hostId” : “tommy123”,
“members” :[
{
“age” : 25,
“department” : “공과대학”,
“gender” : “남”
},
{
“age” : 28,
“department” : “사범대학”,
“gender” : “여”
}
]
}
| |