API Documents

Gitbook Link

📚 explore 페이지 조회

• 비회원 유저가 전체 조회하는 경우
• explore 페이지 홈화면에서 조회될 전체 데이터를 응답한다.
• URL: /expore
• METHOD: GET
• Response

200 { users, "message": "welcome to explore" }
501 { "message": "failed"}

---

🔒 로그인

1. 임시비밀번호 발급 /auth/tmp

• METHOD: POST
• Request

{
  email //user's email
}

• Response

200 { "message": "login failed" }
401 { "message" : "incorrect information" }
501 { "message" : "failed" }

2. 비밀번호 초기화 /auth/pwd

• METHOD: POST
• Request

{
  tempPwd //temporary password
  pwd //reset password
}

• Response

200 { "message" : "ok" }
422 { "message" : "incorrect information"}
500 { "message" : "failed" }

3. 로그인

• URL: /login
• METHOD: POST
• Request

{
  email //user's email
  pwd //user's password
}

---

🔓 로그아웃

• URL: /logout
• METHOD: GET
• Response

200 { "message" : "ok" }
401 { "message" : "not our user" }
501 { "message" : "failed" }

---

🔐 회원가입

• URL: /signup
• METHOD: POST (1) 유저네임 중복 검사 /auth/username
• Response

200 { "message" : "valid username" }
422 { "message" : "incorrect information" }
409 { "message" : "already exists" }
501 { "message" : "failed" }

(2) 이메일 중복 검사 /auth/email

• Response

200 { "message" : "valid email" }
422 { "message" : "incorrect information" }
409 { "message" : "already exists" }
501 { "message" : "failed" }

---

access token 재발급

• URL: /auth/token
• METHOD: GET
• Response

200 { "message": "login successfully" }
401 { "message" : "invalid refresh token" }

---

👤프로필

프로필 조회

• URL: /profile
• METHOD: GET
• Response

200 { "user" : user, "bookmark" : bookmark, "message" : "get profile successfully" }
401 { "message" : "invalid access token" }
500 { "message" : "failed" }

프로필 삭제

• URL: /profile
• METHOD: DELETE
• Response

205 { "message" : "deleted account successfully" }
401 { "message" : "invalid access token" }
501 { "message" : "failed" }

프로필 수정

• URL: /profile/username
• Request
• Content-Type: application/json

{  username: //changing username
}

• URL: /profile/pwd
• Request
• Content-Type: application/json

{  pwd: //current password
   newPwd: //new password
}

• URL: /profile/gitRepo
• Request
• Content-Type: application/json

{  
   gitRepo: //changing gitRepo
}

• URL: /profile/company
• Request
• Content-Type: application/json

{  
  company: //changing company
}

Response

200 { "message" : "edited profile successfully" }
401 { "message" : "invalid access token" }
422 { "message" : "incorrect information" }

---

🏡 콜렉트 페이지 조회

• 전체 조회
• 콜렉트 페이지 홈화면에서 조회될 전체 데이터를 응답한다.
• URL: /collect
• METHOD: GET
• Content-Type: application/json
• Response

{
   bookmarks: [],
   category: ["db", "API"],
   reducedbookmarks: [{
      id: 13,
      title: "Network",
      bookmarks: [{
         id: 1,
         categoryId: 13
         text: "what is the difference between http and https",
         url:"https://www.google.com"
         importance: 0
         color:#f24626
         visitCounts:0
         position: 1, // 카드 위치 순서
      }, {
         id: 2,
         categoryId: 13
         text: "response codes",
         url:"https://app.gitbook.com/@recollect/s/recollect-final/#reset-password"
         importance: 1
         color:#f24626
         visitCounts:0
         position: 2, 
      }]
   }, {
      id: 24,
      title: "NGINX",
      bookmarks: [{
         id: 3, 
         categoryId: 24
         text: "nginx documents",
         url:"http://nginx.org/en/docs/varindex.html"
         importance: 1
         color:#f24626
         visitCounts:0
         position: 3, 
      }, {
         id: 4,
         categoryId: 24
         text: "nginx reverse proxy",
         url:https://blog.webf.zone/ultimate-guide-to-http-cookies-2aa3e083dbae"
         importance: 1
         color:#f24626
         visitCounts:0
         position: 4, 
      }]
   }],
 "message" : "welcome to collect", 
}
401 { "message" : "invalid access token" }
500 { "message" : "failed" }

---

🗂 카테고리

카테고리 수정

• URL: /category
• METHOD: PUT
• Content-Type: application/json
• Resonse

200 { "message" : "edited successfully" }
401 { "message" : "invalid access token" }
501 { "message" : "failed" }

카테고리 삭제

• URL: /category/:id
• METHOD: DELETE
• Response

200 { "message" : "deleted successfully" }
401 { "message" : "invalid access token" }
501 { "message" : "failed" }

---

🏷 북마크

북마크 추가

• URL: /bookmark
• METHOD: POST
• Content-Type: application/json
• Request

{
    category: NGINX,
    text: "nginx reverse proxy",
    url:https://blog.webf.zone/ultimate-guide-to-http-cookies-2aa3e083dbae"
    importance: 1
    color:#f24626
}

• Response

201 { "message" : "created successfully" }
401 { "message" : "invalid access token" }
501 { "message" : "failed" }

북마크 visitCount 추가

• URL: /bookmarks/:id
• METHOD: PATCH

북마크 수정

• URL: /bookmarks/:id
• METHOD: PUT
• Request
• Content-Type: application/json

{
    category: "NGINX,
    text: "nginx reverse proxy",
    url:https://blog.webf.zone/ultimate-guide-to-http-cookies-2aa3e083dbae",
    importance: 1,
    color:#f24626
}

• Response

200 { "message" : "edited successfully" }
401 { "message" : "invalid access token" }
422 { "message" : "incorrect information" }
501 { "message" : "failed" }

북마크 포지션 한개 수정: 카테고리의 맨 마지막으로 이동되는 경우

• position을 가장 큰 값으로 바꿔주는 API -> 따라서 조회시 최하단에 출력되게 된다.
• URL: /bookmarks/:id/position
• METHOD: PATCH
• Request
• Content-Type: application/json

{ categoryId: 1 }

• Response

200 { "message" : "ok" }
401 { "message" : "invalid access token" }
422 { "message" : "incorrect information" }
501 { "message" : "failed" }

북마크 포지션 전체 수정

• dragNo의 position을 dropNo의 position으로 바꿔준 뒤, 하위 카드들의 모든 position을 1씩 더하는 API
• URL: /bookmarks/:dragId/:dropId/position
• METHOD: PATCH
• Request
• Content-Type: application/json

{ categoryId: 1 }

• Response

200 { "message" : "ok" }
401 { "message" : "invalid access token" }
422 { "message" : "incorrect information" }
501 { "message" : "failed" }

북마크 삭제

• URL: /bookmakrs/:id
• METHOD: DELETE
• Response

200 { "message" : "deleted successfully" }
401 { "message" : "invalid access token" }
422 { "message" : "incorrect information" }
501 { "message" : "failed" }

---