API Document

`GET` Get bootcamplists

가장 초기 메인 화면에서, 모든 부트캠프리스트를 다 get해와서 모든 리뷰를 보여준다.

http://localhost:4000/bootcamplists

📥 Request

📤 Response

200:OK

0: {label: "Code States", bootcamp_id: 1, value: 1}
1: {label: "Fast Campus", bootcamp_id: 2, value: 2}
2: {label: "Wecode", bootcamp_id: 3, value: 3}
3: {label: "Vanilla Coding", bootcamp_id: 4, value: 4}
4: {label: "Sparta Codingclub", bootcamp_id: 5, value: 5}
5: {label: "Dream Coding", bootcamp_id: 6, value: 6}
6: {label: "Nomad Coders", bootcamp_id: 7, value: 7}
7: {label: "Code Lion", bootcamp_id: 8, value: 8}

500: Internal Server Error

'err'

`POST` Post Reviews

client에서 요청하는 bootcampList의 bootcamp_id에 해당하는 리뷰 중 active:true인 리뷰들을 보내준다. sesssion을 확인하여 로그인 한 유저는 {isLogin:true} 정보를 함께 보내준다.

http://localhost:4000/reviews

📥 Request

Body Parameter : bootcampList

0: {label: "Code States", bootcamp_id: 1, value: 1}
1: {label: "Fast Campus", bootcamp_id: 2, value: 2}
2: {label: "Wecode", bootcamp_id: 3, value: 3}
3: {label: "Vanilla Coding", bootcamp_id: 4, value: 4}
4: {label: "Sparta Codingclub", bootcamp_id: 5, value: 5}
5: {label: "Dream Coding", bootcamp_id: 6, value: 6}
6: {label: "Nomad Coders", bootcamp_id: 7, value: 7}
7: {label: "Code Lion", bootcamp_id: 8, value: 8}

📤 Response

200:OK

if (!req.session.userid) {
   [{active: true
      bootcamp_id: 1
      bootcampname: {name: "Code States"}
      comment: "진짜 백지부터 프로젝트를 진행 할 수 있는게 좋다. "
      createdAt: "2020-11-03T00:33:20.000Z"
      curriculum: "만족"
      githublink: "https://github.com/Gracechung-sw"
      id: 4
      level: "어려움"
      price: "100만원 이상"
      recommend: "추천"
      updatedAt: "2020-11-03T00:33:20.000Z"
      useremail: {email: "jhjyj5414@naver.com"}},{...}, {...}
   ]}
else{
   [{active: true
      bootcamp_id: 1
      bootcampname: {name: "Code States"}
      comment: "진짜 백지부터 프로젝트를 진행 할 수 있는게 좋다. "
      createdAt: "2020-11-03T00:33:20.000Z"
      curriculum: "만족"
      githublink: "https://github.com/Gracechung-sw"
      id: 4
      level: "어려움"
      price: "100만원 이상"
      recommend: "추천"
      updatedAt: "2020-11-03T00:33:20.000Z"
      useremail: {email: "jhjyj5414@naver.com"}},{...}, {...}
   ], {isLogin:true}
}

404: Not Found {"message":"Error"}

`POST` Create Reviews

client에서 보내는 리뷰 내용을 reviews 테이블에 INSERT한다. ( 기존에 이미 작성한 부트캠프에 대한 중복 작성 불가)

http://localhost:4000/reviews/create

📥 Request

Form Data Parameters

users_id: users_id (req.session.userid),
  > foreign key JOIN
bootcampname
   > bootcamp_id: data.dataValues.id (bootcampname으로 bootcamp_lists 테이블에서 id를 find),
   > foreign key JOIN
githublink: githublink,
active: true,
price: price,
level: level,
recommend: recommend,
curriculum: curriculum,
comment: comment,

📤 Response

201:OK

active: true
bootcamp_id: 1
comment: "gg"
createdAt: "2020-11-03T02:48:03.144Z"
curriculum: "불만족"
githublink: "https://github.com/Gracechung-sw"
id: 8
level: "쉬움"
price: "10만원 이하"
recommend: "비추천"
updatedAt: "2020-11-03T02:48:03.144Z"
users_id: 1

401: 잘못된 부트캠프이름 선택 시,

'unvalid name'

409:

'해당 부트캠프에 대한 리뷰는 이미 작성했습니다.'

500: Internal Server Error

'err'

`PUT` Delete Reviews

user 본인이 작성한 리뷰카드를 삭제한다. 실제로는 soft delete를 구현하여, update 메소드를 통해 reviews 테이블 내의 active 칼럼을 false로 바꿔준다.

http://localhost:4000/reviews/delete

📥 Request

Body Parameter :

users_id: users_id(req.session.userid),
bootcampname: bootcampname,

📤 Response

201:OK

active: false

500: Internal Server Error

'err'

`PUT` Edit Reviews

유저가 자신이 작성한 리뷰를 수정 ( 하나의 부트캠프에 대한 중복 수정 및 기재 불가 )

http://localhost:4000/reviews/edit

📥 Request

Body Parameter :

users_id: users_id (req.session.userid),
bootcampname : bootcampname(변경 원하는 부트캠프이름)
bootcampname_before(유저 별도 입력X)
   > bootcamp_id: data.dataValues.id (bootcampname으로 bootcamp_lists 테이블에서 id를 find),
   > client에서 별도로 보내주는 데이터, 리뷰 수정 시에, 변경하고자 하는 리뷰를 선택하는 기준자가 된다.
githublink: githublink,
active: true,
price: price,
level: level,
recommend: recommend,
curriculum: curriculum,
comment: comment,

📤 Response

201:OK

active: true
bootcamp_id: 2
comment: "gg"
createdAt: "2020-11-03T02:48:03.144Z"
curriculum: "불만족"
githublink: "https://github.com/Gracechung-sw"
id: 8
level: "쉬움"
price: "10만원 이하"
recommend: "비추천"
updatedAt: "2020-11-03T02:48:03.144Z"
users_id: 1

401 :

unvalid name

409 :

해당 부트캠프에 대한 리뷰는 이미 작성했습니다.

500: Internal Server Error

'err'

`POST` Signup

회원가입 API -> githubId에 대한 중복 가입방지를 위해 findOrCreate 활용 소셜로그인 사용자와 구분위해, kind_login 칼럼에 basic 값을 추가하며 DB에 데이터 저장 (client에서 전달되는 데이터는 없고, 서버에서 설정해줌) 이메일 중복 방지는 별도 API 구성

http://localhost:4000/users/signup

📥 Request

useremail: useremail,
password: password,
githubId : githubId

📤 Response

200: OK
401 :

'해당 githubId로는 이미 가입되어있습니다.

500: Internal Server Error

'err'

`POST` Check UserId

회원 가입시에 실시간으로 서버와 클라이언트가 통신하여, 아이디 중복 점검

http://localhost:4000/users/signup/checkId

📥 Request

useremail: e.target.value,

📤 Response

200:OK

 if (users테이블의 email 데이터 !== null) {
          createdAt: "2020-11-02T13:07:51.000Z"
          email: "jhjyj5414@naver.com"
          githubId: "Grace"
          id: 1
          password: "qwerty12345"
          updatedAt: "2020-11-02T13:08:49.000Z"
        } else {
          null
        }

500: Internal Server Error

'err'

`POST` Login

일반회원가입을 통한 고객

http://localhost:4000/users/login

📥 Request

useremail: useremail
password: password

📤 Response

200: OK

{ id: 5 }

401: Unauthorized

'unvalid user'

500: Internal Server Error

'err'

`POST` Logout

http://localhost:4000/users/logout

📥 Request

📤 Response

200: OK

redirect('/');

400: Bad Request

'you are currently not logined'

500: Internal Server Error

'err'

`POST` Find UserId

가입 시 입력한 githubId를 통해, 가입된 메일 find 소셜로그인으로 가입한 사용자가 githubId 입력 시에, 메일주소 찾을 수 없음

http://localhost:4000/users/login/findId

📥 Request

githubId: githubId

📤 Response

200: OK

useremail

400: Bad Request

'have to apply github Id'

409: Bad Request

'소셜로그인으로 가입하셨군요? 아이디찾기 기능을 사용할 수 없습니다'

500: Internal Server Error

'err'

`POST` Find UserPw

정상 요청이 온 거라면 users 테이블에서 useremail과 githubId에 해당하는 row의 password를 찾아서 useremail주소로 보내준 뒤, 응답을 한다.

http://localhost:4000/users/login/findpw

📥 Request

 useremail: useremail,
 githubId: githubId,

📤 Response

200: OK

{ success: true }

400: Bad Request

'informations are not matched or have to sign up '

500: Internal Server Error

'err'

`GET` Read Mypage

서버에서 세션을 확인해서 그에 맞는 회원의 users 테이블 정보와 그 회원이 작성한 reviews를 응답해준다. 이 때, 소셜로그인 이용 유저는, 개인 정보는 마이페이지에서 확인 및 수정할 수 없다.

http://localhost:4000/users/read

📥 Request

📤 Response

200: OK

if (소셜로그인으로 가입한 유저) {
    개인정보데이터 = {}
}
if(리뷰를 작성한 적이 있는 유저){
{ [{id: 1, email: "jhjyj5414@naver.com", password: "qwerty12345", githubId: "Grace", createdAt: "2020-11-02T13:07:51.000Z", …}, 
  [
    {active: true
      bootcamp_id: 1
      bootcampname: {name: "Code States"}
      comment: "진짜 백지부터 프로젝트를 진행 할 수 있는게 좋다. "
      createdAt: "2020-11-03T00:33:20.000Z"
      curriculum: "만족"
      githublink: "https://github.com/Gracechung-sw"
      id: 4
      level: "어려움"
      price: "100만원 이상"
      recommend: "추천"
      updatedAt: "2020-11-03T00:33:20.000Z"
      useremail: {email: "jhjyj5414@naver.com"}},
      {...}, {...}
   ]
}
}
else{
 if (소셜로그인으로 가입한 유저) {
    {{}, …}
 } else {
  {id: 1, email: "jhjyj5414@naver.com", password: "qwerty12345", githubId: "Grace", createdAt: "2020-11-02T13:07:51.000Z", …}
}

401:

'unvalid name'

500: Internal Server Error

'err'

`PUT` Edit UserInfo

users 테이블의 email데이터 중 useremail에 해당하는 row의 password, githubId을 수정하고 세션도 삭제하여서 로그인 전으로 돌아가게 한다.

http://localhost:4000/users/edit

📥 Request

useremail:useremail,
password: password,
githubId: githubId

📤 Response

200:OK

'정보수정 완료'

400: Bad Request

'you are currently not logined'

500: Internal Server Error

'err'

`DELETE` Delete UserInfo

세션을 확인한 뒤 그에 해당하는 유저의 데이터를 삭제하고 세션도 삭제하여서 로그인 전으로 돌아가게 한다.

http://localhost:4000/users/delete

📥 Request

📤 Response

200:OK

session.destroy()

500: Internal Server Error

'err'

`GET` social login page

client에서 href로 링크 이동하게 되면, get method로 소셜 로그인 실행

http://localhost:4000/auth/github

📥 Request

📤 Response

200:OK

const githubAuthUrl =
      'https://github.com/login/oauth/authorize?client_id=' +
      github.clientID +
      '&redirect_uri=' +
      github.redirectUri;

    res.redirect(githubAuthUrl)

500: Internal Server Error

'err'

`GET` social login / redirect page

유저가 소셜에 request token 요청하며 redirect page로 이동되며, 서버가 소셜에 token을 기반으로 인증을 요청하는 client화됨.

http://localhost:4000/auth/github/callback

📥 Request

try {
 axios.post => access token 받아옴
   try {
    axios.get => access token으로 소셜에서 유저 데이터 받아옴
   } catch 
}catch

📤 Response

200:OK

{ githubId : authdata.login 데이터활용,
  email : authdata.id 활용,
  password : authdata.node_id 활용,
  kind_login : 'social'
}

500: Internal Server Error

'err'

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API Document

`GET` Get bootcamplists

`POST` Post Reviews

`POST` Create Reviews

`PUT` Delete Reviews

`PUT` Edit Reviews

`POST` Signup

`POST` Check UserId

`POST` Login

`POST` Logout

`POST` Find UserId

`POST` Find UserPw

`GET` Read Mypage

`PUT` Edit UserInfo

`DELETE` Delete UserInfo

`GET` social login page

`GET` social login / redirect page

Clone this wiki locally

API Document

GET Get bootcamplists

POST Post Reviews

POST Create Reviews

PUT Delete Reviews

PUT Edit Reviews

POST Signup

POST Check UserId

POST Login

POST Logout

POST Find UserId

POST Find UserPw

GET Read Mypage

PUT Edit UserInfo

DELETE Delete UserInfo

GET social login page

GET social login / redirect page

Clone this wiki locally

`GET` Get bootcamplists

`POST` Post Reviews

`POST` Create Reviews

`PUT` Delete Reviews

`PUT` Edit Reviews

`POST` Signup

`POST` Check UserId

`POST` Login

`POST` Logout

`POST` Find UserId

`POST` Find UserPw

`GET` Read Mypage

`PUT` Edit UserInfo

`DELETE` Delete UserInfo

`GET` social login page

`GET` social login / redirect page