Skip to content

taeho99/RideShare-Server

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

91 Commits
Database
Database
 
 
gradle/wrapper
gradle/wrapper
 
 
src
src
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
build.gradle
build.gradle
 
 
gradlew
gradlew
 
 
gradlew.bat
gradlew.bat
 
 
settings.gradle
settings.gradle
 
 

Repository files navigation

RideShare-Server

목차

배포 완료(데모)

https://knu-rideshare.site/

실행방법

https://jojelly.tistory.com/86

데이터베이스 초기설정 및 테스트 데이터 주입

프로젝트의 Database 폴더 -> dbinit.sql 파일의 SQL 문장을 MySQL Workbench에서 모두 실행해주세요.

인텔리제이 초기설정

더보기
  1. file->settings->Build, Execution, Deployment-> Compiler -> Annotation Processors에서 enable annotation processing를 체크표시 해주세요. 캡처
  2. RideshareApplication 파일의 main() 메서드를 실행하면 됩니다.
    캡처2

ERD

더보기

erd

REST API Guide

택시/카풀 총 개수 조회

더보기
  • 택시/카풀 리스트의 총 아이템 개수를 반환합니다.
GET /parties/count

성공: 200 OK

실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 파라미터

필수 Params Type Description
O type String "택시" or "카풀"

요청 예시

GET /parties/count?type=택시
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(TEXT)

20

택시/카풀 리스트 반환 및 검색

더보기
  • lastId 보다 작은 값의 레코드들을 amount개 반환합니다.
  • keyword 필드를 추가하면 원하는 출발지를 검색할 수 있습니다.
GET /parties

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 파라미터

필수 Params Type Description
X lastId Integer 마지막으로 호출 된 id (미입력시 최근 id부터 출력)
X amount Integer 한번에 호출 할 레코드 개수 (미입력시 전체 조회)
X type String "택시" or "카풀" (미입력시 전체 조회)
X keyword String 검색할 키워드(출발지) (미입력시 전체 조회)

요청 예시

GET /parties?lastId=41&amount=3&type=카풀
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(JSON)

[
  {
    "type": "카풀",
    "startDate": "2023-05-20",
    "startTime": "오전 11:20",
    "startPoint": "남춘천역",
    "startLat": "37.86369763697937",
    "startLng": "127.72376542374549",
    "endPoint": "동문",
    "endLat": "37.86546483861883",
    "endLng": "127.7494661352292",
    "currentHeadcnt": 1,
    "totalHeadcnt": 4,
    "isConfirm": false,
    "isFinish": false,
    "carNumber": "237더1028",
    "content": "컨텐츠내용 테스트 예제",
    "people": [
      "test5_nick",
      "test1_nick",
      "test2_nick",
      "test3_nick"
    ],
    "pid": 40
  },
  {
    "type": "카풀",
    "startDate": "2023-05-19",
    "startTime": "오전 11:20",
    "startPoint": "남춘천역",
    "startLat": "37.86369763697937",
    "startLng": "127.72376542374549",
    "endPoint": "미래도서관",
    "endLat": "37.86546483861883",
    "endLng": "127.7494661352292",
    "currentHeadcnt": 1,
    "totalHeadcnt": 4,
    "isConfirm": false,
    "isFinish": false,
    "carNumber": "23우1283",
    "content": "컨텐츠내용 테스트 예제",
    "people": [
      "test4_nick"
    ],
    "pid": 39
  },
  {
    "type": "카풀",
    "startDate": "2023-05-18",
    "startTime": "오전 11:20",
    "startPoint": "남춘천역",
    "startLat": "37.86369763697937",
    "startLng": "127.72376542374549",
    "endPoint": "강원대후문",
    "endLat": "37.86546483861883",
    "endLng": "127.7494661352292",
    "currentHeadcnt": 4,
    "totalHeadcnt": 4,
    "isConfirm": true,
    "isFinish": false,
    "carNumber": "48가9125",
    "content": "컨텐츠내용 테스트 예제",
    "people": [
      "test3_nick"
    ],
    "pid": 38
  }
]

택시/카풀 ID로 조회

더보기 
GET /parties/{pId}

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우
404 `` 파티 ID가 존재하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

GET /parties/40
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(JSON)

{
  "type": "카풀",
  "startDate": "2023-05-20",
  "startTime": "오전 11:20",
  "startPoint": "남춘천역",
  "startLat": "37.86369763697937",
  "startLng": "127.72376542374549",
  "endPoint": "동문",
  "endLat": "37.86546483861883",
  "endLng": "127.7494661352292",
  "currentHeadcnt": 1,
  "totalHeadcnt": 4,
  "isConfirm": false,
  "isFinish": false,
  "carNumber": "237더1028",
  "content": "컨텐츠내용 테스트 예제",
  "people": [
    "test5_nick",
    "test1_nick",
    "test2_nick",
    "test3_nick"
  ],
  "pid": 40
}

파티 등록

더보기 
POST /parties

성공: 201 CREATED
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 필드

필수 Field Type Description
O type String "택시" or "카풀"
O startPoint String 출발지
O startLat String 출발지 위도
O startLng String 출발지 경도
O endPoint String 도착지
O endLat String 도착지 위도
O endLng String 도착지 경도
O totalHeadcnt int 전체 인원 수
O startDate String 출발 날짜
O startTime String 출발 시각
X carNumber String 차량 번호(only 카풀)
X content String 글 내용(only 카풀)

택시 등록 요청 예시(JSON)

POST /parties
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)
{
  "type": "택시",
  "startPoint": "기숙사",
  "startLat": "37.87120749003905",
  "startLng": "127.7431938775162",
  "endPoint": "남춘천역",
  "endLat": "37.86382292163636",
  "endLng": "127.7239030183326",
  "totalHeadcnt": 4,
  "startDate": "2023-04-04",
  "startTime": "오후 02:30"
}

택시 등록 응답 예시(JSON)

{
  "type": "택시",
  "startDate": "2023-04-04",
  "startTime": "오후 02:30",
  "startPoint": "기숙사",
  "startLat": "37.87120749003905",
  "startLng": "127.7431938775162",
  "endPoint": "남춘천역",
  "endLat": "37.86382292163636",
  "endLng": "127.7239030183326",
  "currentHeadcnt": 1,
  "totalHeadcnt": 4,
  "isConfirm": false,
  "isFinish": false,
  "carNumber": null,
  "content": null,
  "people": [
    "test1_nick"
  ],
  "pid": 41
}

카풀 등록 요청 예시(JSON)

POST /parties
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)
{
  "type": "카풀",
  "startPoint": "글로벌경영관",
  "startLat": "37.87120749003905",
  "startLng": "127.7431938775162",
  "endPoint": "남춘천역",
  "endLat": "37.86546483861883",
  "endLng": "127.7494661352292",
  "totalHeadcnt": 4,
  "startDate": "2023-04-19",
  "startTime": "오후 09:10",
  "carNumber": "98가7654",
  "content": "카풀내용수정테스트asdfgh"
}

카풀 등록 응답 예시(JSON)

{
  "type": "카풀",
  "startDate": "2023-04-19",
  "startTime": "오후 09:10",
  "startPoint": "글로벌경영관",
  "startLat": "37.87120749003905",
  "startLng": "127.7431938775162",
  "endPoint": "남춘천역",
  "endLat": "37.86546483861883",
  "endLng": "127.7494661352292",
  "currentHeadcnt": 1,
  "totalHeadcnt": 4,
  "isConfirm": false,
  "isFinish": false,
  "carNumber": "98가7654",
  "content": "카풀내용수정테스트asdfgh",
  "people": [
    "test1_nick"
  ],
  "pid": 42
}

파티 삭제

더보기
  • 글 작성자만 파티를 삭제할 수 있습니다.
DELETE /parties/{pId}

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우
404 `` 파티 ID가 존재하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

DELETE /parties/40
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

파티 수정

더보기
  • 택시 <-> 카풀 간 수정도 가능합니다. 예시를 참고해주세요.
  • 글 작성자만 파티를 수정할 수 있습니다.
PUT /parties/{pId}

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우
404 `` 파티 ID가 존재하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 필드

필수 Field Type Description
O type String "택시" or "카풀"
O startPoint String 출발지
O startLat String 출발지 위도
O startLng String 출발지 경도
O endPoint String 도착지
O endLat String 도착지 위도
O endLng String 도착지 경도
O totalHeadcnt int 전체 인원 수
O startDate String 출발 날짜
O startTime String 출발 시각
X carNumber String 차량 번호(only 카풀)
X content String 글 내용(only 카풀)

택시 -> 카풀 수정 요청 예시(JSON)

PUT /parties/41
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)
{
  "type": "카풀",
  "startPoint": "기숙사",
  "startLat": "37.87120749003905",
  "startLng": "127.7431938775162",
  "endPoint": "남춘천역",
  "endLat": "37.86546483861883",
  "endLng": "127.7494661352292",
  "totalHeadcnt": 4,
  "startDate": "2023-04-04",
  "startTime": "오후 02:30",
  "carNumber": "123고4567",
  "content": "카풀 내용 수정 테스트입니다."
}

택시 -> 카풀 수정 응답 예시(JSON)

{
  "type": "카풀",
  "startDate": "2023-04-04",
  "startTime": "오후 02:30",
  "startPoint": "기숙사",
  "startLat": "37.87120749003905",
  "startLng": "127.7431938775162",
  "endPoint": "남춘천역",
  "endLat": "37.86546483861883",
  "endLng": "127.7494661352292",
  "currentHeadcnt": 1,
  "totalHeadcnt": 4,
  "isConfirm": false,
  "isFinish": false,
  "carNumber": "123고4567",
  "content": "카풀 내용 수정 테스트입니다.",
  "people": [
    "test1_nick"
  ],
  "pid": 41
}

파티 참여하기

더보기
  • 원하는 파티에 참여하는 기능입니다.
  • 파티의 최대 인원수를 초과하는 경우 오류 메시지를 반환합니다.
  • 파티 참여에 성공한다면 현재 인원수를 반환합니다.
PUT /parties/{pId}/participate

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우
400 파티 정원 초과 파티 정원이 초과되어 참여할 수 없는 경우
400 이미 참여중인 파티 사용자가 이미 참여중인 파티이기 때문에 중복 참여가 안되는 경우
400 확정되거나 종료된 파티 이미 확정되거나 종료된 파티를 참여하는 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

PUT /parties/40/participate
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(TEXT) (참여 후 현재 인원이 2인 경우)

2

파티 나가기

더보기
  • 참여하고 있는 파티를 나가는 기능입니다.
PUT /parties/{pId}/leave

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우
400 종료된 파티 종료된 파티를 나가려고 하는 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

PUT /parties/40/leave
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

파티 확정 완료하기

더보기
  • 파티의 is_confirm 값을 true로 변경하는 기능입니다.
  • 글 작성자만 파티 확정 완료가 가능합니다.
PUT /parties/{pId}/confirm

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

PUT /parties/40/confirm
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

파티 종료하기

더보기
  • 파티의 is_finish 값을 true로 변경하는 기능입니다.
  • 글 작성자만 파티 종료가 가능합니다.
PUT /parties/{pId}/finish

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

PUT /parties/40/finish
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

아이디/이메일/닉네임 중복 확인

더보기
  • 아이디와 이메일, 닉네임의 중복여부를 확인하는 기능입니다.
  • GET 요청 파라미터로 아이디, 이메일, 닉네임 중 하나를 포함하야 전송해야 합니다.
GET /members/check

성공: 200 OK (중복 없음)
실패:

Code Message Description
400 ID 중복 ID가 중복된 경우
400 이메일 중복 이메일이 중복된 경우
400 닉네임 중복 닉네임 중복된 경우
400 파라미터 에러 올바르지 않은 요청 파라미터가 전송된 경우

요청 파라미터

필수 Params Type Description
X id String 중복여부 확인할 아이디
X email String 중복여부 확인할 이메일
X nickname String 중복여부 확인할 닉네임

요청 예시 (ID 중복여부)

GET /members/check?id=test1

회원가입

더보기
  • 신규 회원 정보를 입력받고 회원가입 요청을 보내는 기능입니다.
  • 입력했던 이메일로 회원인증 링크를 전송합니다.
POST /members/join

성공: 200 OK

요청 필드

필수 Field Type Description
O id String 아이디(최대 15자)
O pw String 비밀번호
O email String 이메일(현재는 @kangwon.ac.kr 아니여도 가능)
O nickname String 닉네임(최대 15자)

요청 예시

POST /members/join

요청 예시(JSON)

{
  "id": "test1",
  "pw": "1q2w3e4r",
  "email": "[email protected]",
  "nickname": "test1_nick"
}

로그인

더보기
  • 아이디와 비밀번호로 로그인을 하고 Access Token과 Refresh Token을 반환받는 기능입니다.
  • 회원가입 완료 후 이메일 인증을 한 사용자만 로그인이 가능합니다.
POST /members/login

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 아이디 또는 비밀번호 오류
401 메일인증을 완료하지 않았습니다. 이메일 인증 미완료 오류

요청 필드

필수 Field Type Description
O id String 아이디
O pw String 비밀번호

응답 필드

Field Type Description
grantType String 인증타입 (JWT는 Bearer)
accessToken String Access Token (현재 유효기간 30분으로 설정)
refreshToken String Refresh Token (현재 유효기간 7일로 설정)
accessTokenExpiresIn String Access Token 유효기간(현재시각+30분)

요청 예시

POST /members/login

요청 예시(JSON)

{
  "id": "test1",
  "pw": "1q2w3e4r"
}

응답 예시(JSON)

{
  "grantType": "Bearer",
  "accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPTEVfVVNFUiIsImV4cCI6MTY4NDkyOTIwNn0.d0B2AXhmqUO_XIHYfuTVw_yKc-pj3puDV2XGwn8C-SF1yDes39ZZviYk4hBF5b-S2NZUHlmwg9oMnV_uiZBf3Q",
  "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2ODU1MzIyMDZ9.dWnu2y-JoiggvhqbDbjuB1ir-KvqN00F-fXbX7p3vGdTvuOgFwL6U9t0oimwtkZ3MoYPhlskdxd7UkfUxt2lZw",
  "accessTokenExpiresIn": 1684929206327
}

토큰 재발급

더보기
  • 토큰의 유효기간이 만료되면 재발급 받는 기능입니다.
POST /members/reissue

성공: 200 OK
실패:

Code Message Description
401 Refresh Token이 유효하지 않습니다. 잘못된 형식의 Refresh Token이 입력된 경우
401 로그아웃된 사용자입니다. Refresh Token이 존재하지 않습니다. DB 테이블에 Refresh Token이 존재하지 않은 경우
401 Refresh Token이 일치하지 않거나 만료되었습니다. 올바른 형식의 Refresh Token이지만 DB 테이블의 Refresh Token 값과 다른 경우
500 JWT signature does not match locally computed signature. JWT validity cannot be asserted and should not be trusted. Access Token의 Signature부분 위조
500 Unable to read JSON value: ...(이하생략) Access Token의 Header부분이 잘못된 경우
500 Unsupported signature algorithm ...(이하생략) Access Token의 Header부분이 잘못된 경우

요청 필드

Field Type Description
accessToken String Access Token(현재 유효기간 30분으로 설정)
refreshToken String Refresh Token(현재 유효기간 7일로 설정)

응답 필드

Field Type Description
grantType String 인증타입 (JWT는 Bearer)
accessToken String Access Token (현재 유효기간 30분으로 설정)
refreshToken String Refresh Token (현재 유효기간 7일로 설정)
accessTokenExpiresIn String Access Token 유효기간(현재시각+30분)

요청 예시

POST /members/reissue

요청 예시(JSON)

{
  "accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPTEVfVVNFUiIsImV4cCI6MTY4NDkyOTIwNn0.d0B2AXhmqUO_XIHYfuTVw_yKc-pj3puDV2XGwn8C-SF1yDes39ZZviYk4hBF5b-S2NZUHlmwg9oMnV_uiZBf3Q",
  "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2ODU1MzIyMDZ9.dWnu2y-JoiggvhqbDbjuB1ir-KvqN00F-fXbX7p3vGdTvuOgFwL6U9t0oimwtkZ3MoYPhlskdxd7UkfUxt2lZw"
}

응답 예시(JSON)

{
  "grantType": "Bearer",
  "accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPTEVfVVNFUiIsImV4cCI6MTY4NDkyOTcyOH0.dimTO0aPhXQhPGr6X_9CS6DxcO9eLVwyuYr7olzZfugbcfF4sKLruS113sD_fSUAnZN4UEoeTsL1Lm4P7kRcvA",
  "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2ODU1MzI3Mjh9.ZGCwZIvmZMAg23DQFbiEDV500D2LInxmGo3Smw_Q2qo4VVPRWAI_nMIZt-vooKvOyQ-9dBn-jVpRXCBIXWnO-Q",
  "accessTokenExpiresIn": 1684929728723
}

마이페이지

더보기
  • 내 정보를 반환받는 기능입니다.
  • HTTP 헤더의 Authorization 필드에 Access Token을 포함하여 전송해야 합니다.
  • 꼭 파라미터나 HTTP BODY가 아닌 HTTP 헤더에 토큰을 전송해야 합니다.
GET /members/me

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

응답 필드

Field Type Description
id String 아이디
pw String 비밀번호
nickname String 닉네임
email String 이메일
authCode Integer 인증코드(6자리 랜덤숫자)
authStatus Boolean 인증상태(인증완료: true, 인증미완료: false)
authority String 권한(ROLE_USER / ROLE_ADMIN)
score Integer 리뷰 점수
mid Integer 멤버ID (DB 기본키)

요청 예시

GET /members/me
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(JSON)

{
  "id": "test1",
  "pw": "$2a$10$KSAzA388kbsSZNvgLc1enO.EXAlKlBn/XmbNPd.xKC5f3ONXyIQrK",
  "nickname": "test1_nick",
  "email": "[email protected]",
  "authCode": 915897,
  "authStatus": true,
  "authority": "ROLE_USER",
  "score": 50,
  "mid": 4
}

상대방 프로필 조회

더보기
  • 다른 이용자의 정보를 조회하는 기능입니다.
  • 다른 이용자의 ID 또는 mId(DB 기본키)를 이용하여 정보를 조회할 수 있습니다.
GET /members/id/{id}
GET /members/mid/{mid}

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

응답 필드

Field Type Description
id String 아이디
pw String 비밀번호
nickname String 닉네임
email String 이메일
authCode Integer 인증코드(6자리 랜덤숫자)
authStatus Boolean 인증상태(인증완료: true, 인증미완료: false)
authority String 권한(ROLE_USER / ROLE_ADMIN)
score Integer 리뷰 점수
mid Integer 멤버ID (DB 기본키)

요청 예시(id로 조회)

GET /members/id/test1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

요청 예시(mid로 조회)

GET /members/mid/1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(JSON)

{
  "id": "test1",
  "pw": "$2a$10$KSAzA388kbsSZNvgLc1enO.EXAlKlBn/XmbNPd.xKC5f3ONXyIQrK",
  "nickname": "test1_nick",
  "email": "[email protected]",
  "authCode": 915897,
  "authStatus": true,
  "authority": "ROLE_USER",
  "score": 50,
  "mid": 4
}

로그아웃

더보기
  • 로그아웃 요청이 들어오면 Refresh Token을 삭제하는 기능입니다.
POST /members/logout

성공: 200 OK
실패:

Code Message Description
401 로그아웃된 사용자입니다. Refresh Token이 존재하지 않습니다. DB 테이블에 Refresh Token이 존재하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

POST /members/logout
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

작성글 내역 조회

더보기
  • 로그인한 사용자가 개설한 파티를 조회합니다.
GET /members/notice-list

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

GET /members/notice-list
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(JSON)

[
  {
    "type": "택시",
    "startDate": "2023-04-01",
    "startTime": "오전 11:20",
    "startPoint": "백록관",
    "startLat": "37.868442369510475",
    "startLng": "127.7409329182267",
    "endPoint": "남춘천역",
    "endLat": "37.86546483861883",
    "endLng": "127.7494661352292",
    "currentHeadcnt": 1,
    "totalHeadcnt": 4,
    "isConfirm": false,
    "isFinish": false,
    "carNumber": null,
    "content": null,
    "people": [
      "test1_nick"
    ],
    "pid": 1
  },
  {
    "type": "택시",
    "startDate": "2023-04-06",
    "startTime": "오전 11:20",
    "startPoint": "천지관",
    "startLat": "37.87119862478267",
    "startLng": "127.74317105800883",
    "endPoint": "남춘천역",
    "endLat": "37.86546483861883",
    "endLng": "127.7494661352292",
    "currentHeadcnt": 1,
    "totalHeadcnt": 4,
    "isConfirm": false,
    "isFinish": false,
    "carNumber": null,
    "content": null,
    "people": [
      "test1_nick"
    ],
    "pid": 6
  }
]

파티 참여내역 조회

더보기
  • 로그인한 사용자가 참여한 파티를 조회합니다.
  • 직접 개설한 파티는 조회되지 않으며 다른 이용자가 개설한 파티에 참여한 경우만 조회됩니다.
GET /members/participation-list

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

GET /members/participation-list
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(JSON)

[
  {
    "type": "카풀",
    "startDate": "2023-05-20",
    "startTime": "오전 11:20",
    "startPoint": "남춘천역",
    "startLat": "37.86369763697937",
    "startLng": "127.72376542374549",
    "endPoint": "동문",
    "endLat": "37.86546483861883",
    "endLng": "127.7494661352292",
    "currentHeadcnt": 1,
    "totalHeadcnt": 4,
    "isConfirm": false,
    "isFinish": false,
    "carNumber": "237더1028",
    "content": "컨텐츠내용 테스트 예제",
    "people": [
      "test5_nick",
      "test1_nick",
      "test2_nick",
      "test3_nick"
    ],
    "pid": 40
  }
]

닉네임 변경

더보기
  • 사용자의 닉네임을 변경하는 기능입니다.
  • 닉네임의 중복 체크는 /members/check 를 이용하면 됩니다.
PUT /members/nickname

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 필드

필수 Field Type Description
O nickname String 변경할 새로운 닉네임

요청 예시

PUT /members/nickname
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

요청 예시(JSON)

{
  "nickname": "newNick1"
}

비밀번호 변경

더보기
  • 사용자의 비밀번호를 변경하는 기능입니다.
  • 비밀번호 변경 후에는 로그아웃 처리 됩니다.
PUT /members/password

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우
400 기존 비밀번호가 일치하지 않습니다. 기존 비밀번호가 잘못 입력된 경우
400 새로운 비밀번호가 기존 비밀번호와 일치합니다. 새로운 비밀번호와 기존 비밀번호가 일치한 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 필드

필수 Field Type Description
O oldPassword String 기존 비밀번호
O newPassword String 새로운 비밀번호

요청 예시

PUT /members/password
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

요청 예시(JSON)

{
  "oldPassword": "1q2w3e4r",
  "newPassword": "1q2w3e"
}

나의 점수 조회

더보기
  • 나의 리뷰 점수를 확인하는 기능입니다.
  • 점수는 100점 만점이며 평균값을 반올림하여 반환합니다.
  • 만약 리뷰가 1건도 존재하지 않으면 score 필드에 null 값을 반환합니다.
  • (싫어요: 0점, 보통이에요: 50점, 좋아요: 100점)
GET /review

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

응답 필드

Field Type Description
mid Integer 멤버 ID (DB 기본키)
id String 아이디
nickname String 닉네임
score Integer 리뷰 점수

요청 예시

GET /review
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(JSON)

{
  "mid": 1,
  "id": "test1",
  "nickname": "newNick1",
  "score": 62
}

다른 사용자의 점수 조회

더보기
  • mid, id, pid를 이용하여 다른 사용자의 리뷰 점수를 확인하는 기능입니다.
  • pid(파티 ID)를 이용하여 점수 조회시 파티장(글쓴이)의 리뷰 점수를 반환합니다.
  • 점수는 100점 만점이며 평균값을 반올림하여 반환합니다.
  • 만약 리뷰가 1건도 존재하지 않으면 score 필드에 null 값을 반환합니다.
  • (싫어요: 0점, 보통이에요: 50점, 좋아요: 100점)
GET /review/mid/{mid}
GET /review/id/{id}
GET /review/pid/{pid}

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

응답 필드

Field Type Description
mid Integer 멤버 ID (DB 기본키)
id String 아이디
nickname String 닉네임
score Integer 리뷰 점수

요청 예시(mid로 조회)

GET /review/mid/1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

요청 예시(id로 조회)

GET /review/id/test1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

요청 예시(pid로 조회)

GET /review/pid/1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시(JSON)

{
  "mid": 1,
  "id": "test1",
  "nickname": "newNick1",
  "score": 62
}

다른 사용자의 점수 입력

더보기
  • mid, id, pid를 이용하여 다른 사용자의 리뷰 점수를 입력하는 기능입니다.
  • pid(파티 ID)를 이용하여 점수 입력시 파티장(글쓴이)의 리뷰 점수를 입력합니다.
  • 점수는 100점 만점입니다. (싫어요: 0점, 보통이에요: 50점, 좋아요: 100점)
POST /review/mid/{mid}
POST /review/id/{id}
POST /review/pid/{pid}

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우
400 파티가 종료되지 않았습니다. 종료되지 않은 파티의 파티장을 평가한 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시(mid로 평가)

POST /review/mid/1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)
{
    "score": 100
}

요청 예시(id로 평가)

POST /review/id/test1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)
{
    "score": 100
}

요청 예시(pid로 평가)

POST /review/pid/1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)
{
    "score": 100
}

웹소켓 접속 방법

더보기
  • 로그인 시 웹소켓과 커넥션을 맺어야 합니다.
  • 웹소켓 접속 URL은 아래와 같습니다.
ws://localhost:8080/stomp

메시지 발행

더보기
  • 아래 URI로 메시지를 발행(송신)할 수 있습니다.
  • roomId는 pId와 동일합니다.
/pub/chat/room/{roomId}

메시지 발행 예시

{
  "message": "안녕하세요?",
  "sender": "사용자1"
}

메시지 구독

더보기
  • 아래 URI로 발행된 메시지를 구독(수신)할 수 있습니다.
  • roomId는 pId와 동일합니다.
/sub/chat/room/{roomId}

메시지 구독 예시

{
  "chatId": 36,
  "sender": "사용자1",
  "message": "안녕하세요?",
  "time": "2023-08-23 19:11:17",
  "roomId": 1
}

본인의 채팅방 조회

더보기
  • 로그인한 사용자가 참여중인 채팅방(파티)을 조회합니다.
  • 반환되는 데이터는 파티내역 조회와 일치합니다.
GET /chat/rooms

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

GET /chat/rooms
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시

[
    {
        "type": "택시",
        "startDate": "2023-04-02",
        "startTime": "오전 11:20",
        "startPoint": "글로벌경영관",
        "startLat": "37.8695401263153",
        "startLng": "127.74543307476856",
        "endPoint": "남춘천역",
        "endLat": "37.86546483861883",
        "endLng": "127.7494661352292",
        "currentHeadcnt": 1,
        "totalHeadcnt": 4,
        "isConfirm": false,
        "isFinish": false,
        "carNumber": null,
        "content": null,
        "people": [
            "test2_nick"
        ],
        "pid": 2
    },
    {
        "type": "택시",
        "startDate": "2023-04-07",
        "startTime": "오전 11:20",
        "startPoint": "중앙도서관",
        "startLat": "37.87083174292327",
        "startLng": "127.74420160286947",
        "endPoint": "남춘천역",
        "endLat": "37.86546483861883",
        "endLng": "127.7494661352292",
        "currentHeadcnt": 1,
        "totalHeadcnt": 4,
        "isConfirm": false,
        "isFinish": false,
        "carNumber": null,
        "content": null,
        "people": [
            "test2_nick"
        ],
        "pid": 7
    }
]

기존 채팅내역 불러오기

더보기
  • 사용자가 보낸 채팅은 채팅방을 나가면 (뷰가 전환되면) 삭제되기 때문에 기존 채팅내역을 불러오는 기능입니다.
  • roomId를 URL에 포함하여 전달하면 해당 채팅방의 모든 과거 채팅내역들을 반환합니다.
  • 과거순부터 차례대로 데이터를 반환합니다.
GET /chat/list/{roomId}

성공: 200 OK
실패:

Code Message Description
401 Access Token이 만료되었습니다. 사용자의 Access Token이 만료되었거나 유효하지 않은 경우

요청 헤더

Name Description
Authorization Bearer + JWT Access Token

요청 예시

GET /chat/room/1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI0IiwiYXV0aCI6IlJPT...(이하 생략)

응답 예시

[
  {
    "chatId": 17,
    "sender": "사용자1",
    "message": "안녕하세요?",
    "time": "2023-08-18 21:37:43",
    "roomId": 1
  },
  {
    "chatId": 30,
    "sender": "사용자2",
    "message": "반갑습니다.",
    "time": "2023-08-22 20:08:29",
    "roomId": 1
  },
  {
    "chatId": 36,
    "sender": "사용자1",
    "message": "여기는 1번 파티의 채팅방입니다!",
    "time": "2023-08-23 19:11:17",
    "roomId": 1
  }
]

TODO

  • 로그아웃 하고나서 마이페이지 조회 가능한 오류 수정
  • 파티 참여내역 조회 - 특정 시간(종료 후 24시간) 후 자동삭제 되게끔 설정 (이 시간안에 리뷰작성)
  • 프로필 이미지(MEMBER 테이블에 프로필 이미지 URL 저장하는 컬럼 추가하기)

참고

About

택시/카풀 매칭 서비스 RideShare 서버

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages