API 명세

API 명세

• json: 카멜케이스 사용

로그인 API

POST /auth/login

req

• 로그인 요청

{
    "userId": "myid",
    "password": "p@ssw0rd"
}

---

res

• 로그인 성공

{
    "statusCode": 200,
    "data": {
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
        "userId": "abcd1234",
    }
}

• 로그인 실패

{
    "statusCode": 401,
    "error": "Unauthorized",
    "message": "로그인에 실패했습니다"
}

로그아웃 API

GET /auth/logout

req

---

res

• 로그아웃 성공

{
    "status": 200
}

• 로그아웃 실패

{
    "status": 404
}

회원가입 API

POST /user

req

• 회원가입 요청

{
    "userId": "userId",
    "password": "randowPW",
    "pace": 390,
    "hCode": "11000000",
    "email": "[email protected]",
    "receiveMail": true,
}

---

res

• 회원가입 성공시

{
    "statusCode": 201
}

• 회원가입 실패시

{
    "statusCode": 400,
    "error": "Bad Request",
    "message": "회원가입에 실패했습니다"
}

ID 중복 검사 API

GET /user/:id

req

---

res

• 중복 검사 응답

{
    "statusCode": 200,
    "data": {
        "isExisting": true/false,
    }
}

토큰 갱신 API

GET /auth/refresh

req

• 갱신 요청시
  • HEADER
    • Authorization: Bearer

---

res

• 갱신 성공시

{
    "statusCode": 201,
    "data": {
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
        "userId": "abcd1234",
    }
}

• 갱신 실패시

{
    "statusCode": 401,
    "error": "Unauthorized",
    "message": "Invalid refresh token"
}

모집 목록 조회/검색/필터 API

req

GET /recruit?query=제목입니다&hour=3&dist=5&maxLen=3000&minLen=1000&page=1&pageSize=10&title=true&author=true

res

{
    "statusCode": 200,
    "data": [
        {
            "id": 1,
            "title": "Happy Tears",
            "startTime": "2022-01-08T18:28:50.000Z",
            "maxPpl": 4,
            "currentPpl": 3,
            "userId": "June1010",
            "pace": 300,
            "createdAt": "2022-11-21T08:55:33.171Z",
            "course": {
                "id": 3,
                "title": "The Vengeance of Fu Manchu",
                "path": [{lat: 0, lng: 0}, {lat: 1, lng: 1}],
                "pathLength": 708,
                "userId": "June1010",
                "hDong": {
                    "name": "잠실동",
                },
                "createdAt": "2022-11-21T08:55:33.171Z",
            }
        }, ...
    ]
}

// 모집글의 코스 정보의 지역으로 모집글 지역을 대체하는 느낌 // 모집글 전체 목록 필드에 요청한 유저의 ID가 참여중인 모집글이면 "isParticipating" 추가 고려해보기

코스 목록 조회/검색/필터 API

req

`GET /course?query=제목입니다&dist=5&maxLen=3000&minLen=1000&page=1&pageSize=10&title=true&author=true`

---

res

{
    "statusCode": 200,
    "data": [
        {
            "id": 3,
            "title": "The Vengeance of Fu Manchu",
            "path": [{"lat": 0, "lng": 0}, {"lat": 1, "lng": 1}],
            "pathLength": 708,
            "userId": "June1010",
            "hDong": {
                "name": "잠실동",
            },
            "createdAt": "2022-11-21T08:55:33.171Z"
        }, ...
    ]
}

모집 상세 페이지 API

GET /recruit/:id

req

---

res

{
    "statusCode": 200,
    "data": {
        "title": "달려~달려~",
        "startTime": "2022-11-21T08:55:33.171Z",
        "maxPpl": 5,
        "currentPpl": 3,
        "path": [{lat:123, lng: 123}, ... ],
        "pathLength": 33,
        "pace": 20,
        "hDong": {
            "name": "잠실동"
        },
        "userId": "pushedrumex",
        "isParticipating": true/false,
        "isAuthor": true/false,
    }
}

코스 상세 페이지 API

GET /course/:id

req

---

res

{
    "statusCode": 200,
    "data": {
        "id": 3,
        "title": "The Vengeance of Fu Manchu",
        "path": [{"lat": 0, "lng": 0}, {"lat": 1, "lng": 1}],
        "pathLength": 708,
        "userId": "June1010",
        "hDong": {
            "name": "잠실동",
        },
        "createdAt": "2022-11-21T08:55:33.171Z"
    }
}

모집 참여 API (참여 버튼 누르면 API)

POST /recruit/join HEADER : Authorization: Bearer

req

{
    "recruitId": 1,
}                

---

res

• 참가 요청 성공시

{
    "statusCode": 201,
}

• 참가 요청 실패시 (참가신청인원 꽉찬경우 & 글이 갑자기 삭제된 경우)

{
    "status": 404(존재하지 않는 글에 신청) / 423(내가 내꺼 신청, 이미 신청, 마감),
    "error": "Not Found" / "Locked",
    "message": "존재하지 않는 모집글입니다" / "자신의 모집에 등록할 수 없습니다" / "모집 상한에 도달했습니다" / "이미 참여중인 모집글입니다"
    }
}

모집 등록 API

POST /recruit HEADER : Authorization: Bearer

req

{
    "title": "제목입니다",
    "startTime": "2022-11-15T09:00",
    "maxPpl": 3,
    "pace": 365,
    "courseId": 40,
}

---

res

• 모집 등록 성공시

{
    "statusCode": 201,
    "data": {
        "recruitId": 210
    }
}

• 모집 등록 실패시

// interceptor로 가로채서 변환
{
    "statusCode": 500,
    "error": "Internal server error"
    "message": "요청에 실패하였습니다. 다시 시도해주세요"
}

코스 등록 API

POST /course HEADER : content-type application/json, Authorization: Bearer

req

{
    "title": "제목",
    "path": [{lat: 33, lng: 126},{lat: 33, lng: 126},{lat: 33, lng: 126},{lat: 33, lng: 126}],
    "pathLength": 3800,
    "hCode": "1100000000"
}

---

res

• 코스 등록 요청 성공시

{
    "statusCode": 201,
    "data": {
        "courseId": 234
    }
}

• 코스 등록 요청 실패시

// interceptor로 가로채서 변환
{
    "statusCode": 500,
    "error": "Internal server error"
    "message": "요청에 실패하였습니다. 다시 시도해주세요"
}

내 정보 조회 API

GET /user/me
Header : Authorization: Bearer

req

---

res

• 내 정보 조회 요청 성공시

{
    "statusCode": 200,
    "data": {
        "userId": "June1010"
        "hDong": {
            "name": "서울특별시",
        },
        "pace": 380,
    }
}

• 내 정보 조회 요청 실패시

// interceptor로 가로채서 변환 // 401은 무조건 로그인 페이지로 변환
{
    "statusCode": 401,
    "error": "Unauthorized"
    "message": "로그인이 필요한 서비스입니다"
}

내 정보 수정 API

PATCH /user/me Header : Authorization: Bearer

req

{
    "pace"?: 365,
    "hCode"?: "1100000000"
}

---

res

• 내 정보 수정 요청 성공시

{
    "statusCode": 201
}

• 내 정보 수정 요청 실패시

{
    "status": 401,
    "error": "UnAuthorized",
    "message": "로그인이 필요한 서비스입니다" 
}

내 참여 목록 API

GET /user/me/recruit Header : Authorization: Bearer

req

---

res

• 내 참여 모집목록 요청 성공시

{
    "statusCode": 200,
    "data": [
        {
            "id": 1,
            "title": "Happy Tears",
            "startTime": "2022-01-08T18:28:50.000Z",
            "maxPpl": 4,
            "currentPpl": 3,
            "userId": "모집글작성자",
            "pace": 300,
            "createdAt": "2022-11-21T08:55:33.171Z",
            "course": {
                "id": 3,
                "title": "The Vengeance of Fu Manchu",
                "path": [{lat: 0, lng: 0}, {lat: 1, lng: 1}],
                "pathLength": 708,
                "userId": "코스작성자",
                "hDong": {
                    "name": "잠실동",
                },
                "createdAt": "2022-11-21T08:55:33.171Z",
            }
        }, ...
    ]
}

• 내 참여 모집목록 요청 실패시

{
    "status": 401,
    "error": "UnAuthorized",
    "message": "로그인이 필요한 서비스입니다" 
}

내 코스 목록 API

GET /user/me/course Header : Authorization: Bearer

req

---

res

• 내 코스 목록 요청 성공시

{
    "statusCode": 200,
    "data": [
        {
            "id": 3,
            "title": "The Vengeance of Fu Manchu",
            "path": [{lat: 0, lng: 0}, {lat: 1, lng: 1}],
            "pathLength": 708,
            "userId": "코스 작성자",
            "hDong": {
                "name": "잠실동",
            },
            "createdAt": "2022-11-21T08:55:33.171Z"
        }, ...
    ]
}

• 내 코스 목록 요청 실패시

{
    "status": 401,
    "error": "UnAuthorized",
    "message": "로그인이 필요한 서비스입니다" 
}

모집 취소 API

DELETE /recuit/:id HEADER : content-type application/json, Authorization: Bearer

req

---

res

• 모집 취소 요청 성공 시

{
    "statusCode": 200,
}

• 모집 취소 요청 실패 시

{
    "statusCode": 500,
    "error": "Internal server error"
    "message": "요청에 실패하였습니다. 다시 시도해주세요"
}

참여 취소 API

DELETE /recuit/:id/join HEADER : content-type application/json, Authorization: Bearer

req

---

res

• 참여 취소 요청 성공 시

{
    "statusCode": 200,
}

• 참여 취소 요청 실패 시

{
    "statusCode": 500,
    "error": "Internal server error",
    "message": "요청에 실패하였습니다. 다시 시도해주세요"
}