API 명세

API 명세

• json: 카멜케이스 사용

로그인 API

POST /auth/login

req

• 로그인 요청

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

---

res

• 로그인 성공

{
    "status": 200,
    "data": {
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
        "userId": "abcd1234",
        "id": 3,
    }
}

• 로그인 실패

{
    "status": 401,
    "error": {
        "message": "Your login request has failed",
    }
}

로그아웃 API

GET /auth/logout

req

---

res

• 로그아웃 성공

{
    "status": 200
}

• 로그아웃 실패

{
    "status": 404
}

회원가입 API

POST /user

req

• 회원가입 요청

{
    "userId": "userId",
    "password": "randowPW",
    "pace": 390,
    "zipCode": 01234,
}

---

res

• 회원가입 성공시

{
    "status": 201
}

• 회원가입 실패시

{
    "status": 400
}

ID 중복 검사 API

GET /check/user/:id

req

---

res

• 중복 검사 응답

{
    "status": 200,
    "exists": true/false
}

토큰 갱신 API

GET /auth/refresh

req

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

---

res

• 갱신 성공시

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

• 갱신 실패시

{
    "status": 401,
    "error": {
        "message": "Invalid refresh token"
    }
}

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

req

---

res

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

req

---

res

모집 상세 페이지 API

GET /recruit/:id

req

---

res

{
    title: "달려~달려~",
    startTime: 2022-11-11-20:20,
    maxPpl: 5,
    currentPpl: 3,
    path: [{lat:123, lng: 123}, ... ],
    pathLength: 33,
    pace: 20,
    hCode: "12345",
    userId: "pushedrumex",
}

코스 상세 페이지 API

GET /course/:id

req

---

res

{
    title: "~~ 코스입니다.",
    pathLength: 100,
    hCode: "12345",
    userId: "pushedrumex"
}

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

POST /recruit/join HEADER : Authorization: Bearer

req

{
    "recruitId": "1",
    "userId": "34", // 변경된 부분: 사용자 id -> DB에서의 id값(PK)
}                

---

res

• 참가 요청 성공시

{
    "status": 201,
    "success": true/false
}

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

{
    "status": 409,
    "error": {
        "message": "Maximum cap reached" / "Deleted post"
    }
}

모집 등록 API

POST /recruit HEADER : Authorization: Bearer

req

{
    "title": "제목입니다",
    "courseId": "40",
    "startTime": "2022-11-15 09:00:00",
    "maxPpl": 3,
    "pace": 365,
    "zipCode": 1234,
    "authorId": "jagijasin"
}

---

res

• 모집 등록 성공시

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

• 모집 등록 실패시

{
    "status": 500,
    "error": {
        "message": "Internal server error" 
    }
}

코스 등록 API

POST /course HEADER : content-type multipart/form-data, Authorization: Bearer

req

{
    "title": "제목",
    "path": [{lat: 33, lng: 126},{lat: 33, lng: 126},{lat: 33, lng: 126},{lat: 33, lng: 126}],
    "pathLength": 3800,
    "userId": "abcd1234",
    "img" : "data................."
}

---

res

• 코스 등록 요청 성공시

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

• 코스 등록 요청 실패시

{
    "status": 500,
    "error": {
        "message": "Internal server error" 
    }
}

내 정보 조회 API

GET /user/:userId/profile
Header : Authorization: Bearer

req

---

res

• 내 정보 조회 요청 성공시

{
    "status": 200,
    "data": {
        "userId": "abcd1234",
        "zipCode": 12354,
        "pace": 380,
    }
}

• 내 정보 조회 요청 실패시

{
    "status": 500,
    "error": {
        "message": "Internal server error" 
    }
}

유저 정보 수정 API

PATCH /user/:userId/profile Header : Authorization: Bearer

req

{
    "pace"?: 365,
    "zipCode"?: 12367
}

---

res

• 내 정보 수정 요청 성공시

{
    "status": 201
}

• 내 정보 수정 요청 실패시

{
    "status": 500,
    "error": {
        "message": "Internal server error" 
    }
}

유저 참여 목록 API

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

req

---

res

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

{
    "status": 200,
    "data": {
        "recruits": [
            {
                "title": "1번 모집글",
                "recruitId": "1",
                "courseId": "1",
                "startTime": "2022-11-15 09:00:00",
                "maxPpl": 3,
                "pace": 365,
                "zipCode": 12345,
                "authorId": "jagijasin"   
            },
            {
                "title": "2번 모집글",
                "recruitId": "2",
                "courseId": "2",
                "startTime": "2022-11-15 09:00:00",
                "maxPpl": 3,
                "pace": 365,
                "zipCode": 12345,
                "authorId": "jagijasin" 
            }, ...
        ]
    }
}

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

{
    "status": 500,
    "error": {
        "message": "Internal server error"
    }
}

유저 코스 목록 API

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

req

---

res

• 유저 코스 목록 요청 성공시

{
    "status": 200,
    "data": {
        courses: [
            {
                "title": "제목1",
                "courseId": 1,
                "path": [(1, 1), (2, 2), (3, 3)...],
                "pathLength": 3800,
                "userId": "abcd1234",
                "img" : "https://ncp.storage.imglink"
            }, 
            {
                "title": "제목2",
                "courseId": 2,
                "path": [(1, 1), (2, 2), (3, 3)...],
                "pathLength": 3800,
                "userId": "abcd1234",
                "img" : "https://ncp.storage.imglink"
            }, ...
        ]
        
    }
}

• 유저 코스 목록 요청 실패시

{
    "status": 500,
    "error": {
        "message": "Internal server error"
    }
}