API_User - Laterality/yummy-dishes-REST GitHub Wiki

---

Index

• 사용자 생성
• 사용자 로그인
• 사용자 조회
• 사용자 갱신
• 사용자 제거
• 중복 확인
• 리뷰 조회
• 쿠폰 조회
• 장바구니 추가
• 수량 변경
• 장바구니의 제품 제거

---

---

사용자를 생성하는 API입니다.

• URL

  /user/register

• Method:

  POST

• URL Params

  none

• Data Params

  Body

  email

  string

  사용자 이메일 (유효성 검사 필요)

  password

  string

  암호화되지 않은(raw) 사용자 패스워드 (유효성 검사 필요)

  username

  string

  사용자 유저네임(유효성 검사 필요)

  login_type

  string

  로그인 형태 ["native", "google"]

  access_token

  string

  외부 플랫폼에 의한 가입인 경우, 액세스 토큰

  phone_number

  string

  사용자 휴대폰 번호 (하이픈('-') 제외, 유효성 검사 필요)

  age

  integer

  사용자 연령대

  device_id

  string

  푸시알림을 위한 device registration id

• Success Response:

  • Code: 201
    Content:

    { 
    	"result": "ok",
    	"user": UserModel
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    user

    UserModel

    요청이 성공한 경우 생성된 사용자에 대한 정보

• Error Response:

  • Code: 405 INVALID PARAMETERS
    Content:

    {
    	"result": "fail",
    	"message": "invalid parameters"
    }
    

  OR

  • Code: 409 DUPLICATES
    Content:

    {
    	"result": "fail",
    	"message": "email or username duplicates"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  {
    "email": "[email protected]",
    "username": "JohnSmith",
    "password": "p@ssW0rd",
    "login_type": "native",
    "phone_number": "01012345678",
    "age": 20,
    "device_id": "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
  }
  

• Notes:

  • 구글 등 타 플랫폼 계정을 이용하는 경우 본 API 호출 전에 login API를 먼저 호출해서 게정 생성 가능 여부를 확인해야 합니다.
  • email, password, username 등에 대해 API 호출 전에 반드시 유효성 검사가 이루어져야 합니다.
  • 푸시알림과 개인정보 이용 동의는 생성시 기본값을 '동의함'으로 생성하므로, 필요한 경우 갱신 API를 호출해야 합니다.

---

사용자 로그인 API입니다.

• URL

  /user/login

• Method:

  POST

• URL Params

  none

• Data Params

  Body

  email

  string

  사용자 이메일 (유효성 검사 필요)

  password

  string

  암호화되지 않은(raw) 사용자 패스워드 (유효성 검사 필요)

  login_type

  string

  로그인 형태 ["native", "google"]

• Success Response:

  • Code: 200
    Content:

    {
    	"result": "ok",
    	"message": "redirect to sign up"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    user

    UserModel

    로그인에 성공한 경우 사용자 정보

  OR

  • Code: 201
    Content:

    { 
    	"result": "ok",
    	"user": {
    		...
    	}
    }
    

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	result: "fail",
    	message: "email or password incorrect"
    }
    

  OR

  • Code: 405 INVALID PARAMETERS
    Content:

    {
    	"result": "fail",
    	"message": "invalid parameters"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	result: "error",
    	message: "server fault"
    }
    

• Sample Call:

  {
    "email": "[email protected]",
    "password": "p@ssW0rd",
    "login_type": "native",
  }
  

• Notes:

  • 외부계정 회원의 경우 회원가입 전에 본 API를 호출해서 회원가입 여부를 확인해주세요.
  • login_type이 native가 아닌 경우 status code가 200이면 외부계정 사용자의 회원가입이 필요한 경우이므로 클라이언트에서 이를 처리해야 합니다.
  • email, password 등에 대해 API 호출 전에 반드시 유효성 검사가 이루어져야 합니다.
  • 푸시알림과 개인정보 이용 동의는 생성시 기본값을 '동의함'으로 생성하므로, 필요한 경우 갱신 API를 호출해야 합니다.

---

사용자 정보 조회 API입니다.

• URL

  /user/{userId}

• Method:

  GET

• URL Params

  Required:

  userId

  string

  사용자의 "_id" 필드 값

  Optional:

  q

  string

  요청하는 사용자 정보(,로 분리)

  ["login_type", "phone_number", "date_reg", "age", "accept_push", "accept_privacy", "bucket", "tastes", "likes", "comments", "coupons", "cnt_reviewable", "cnt_stamp", "classes_prefer"]

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    {
    	"result": "ok",
    	"User": {
    		...
    	}
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    user

    UserModel

    요청에 성공한 경우 사용자 정보

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	result: "fail",
    	message: "not found"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	result: "error",
    	message: "server fault"
    }
    

• Sample Call:

  Path: GET /user/599297a54a03b51a11aa3d27?q=likes,comments,coupons
  

• Notes:

  • 쿼리문자열은 대소문자 구분합니다. 소문자로만 입력해주세요.
  • 쿼리문자열에 공백 들어가지 않음에 유의하세요.

---

사용자 정보 갱신 API입니다.

• URL

  /user/{userId}/update

• Method:

  PUT

• URL Params

  Required:

  userId

  string

  사용자의 "_id" 필드 값

• Data Params

  email

  string

  새로운 이메일

  username

  string

  새로운 사용자명

  device_id

  string

  새로운 device registration id

  tastes

  Array<string>

  사용자 입맛

  cnt_stamp

  integer

  새로운 스탬프 개수

• Success Response:

  • Code: 200
    Content:

    {
    	"result": "ok",
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	result: "fail",
    	message: "user not found"
    }
    

  OR

  • Code: 409 USERNAME DUPLICATES
    Content:

    {
    	result: "fail",
    	message: "username duplicates",
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	result: "error",
    	message: "server fault"
    }
    

• Sample Call:

  Path: PUT /user/599297a54a03b51a11aa3d27
  
  {
      "cnt_stamp": 2,
  }
  

• Notes:

  • Request Body의 각 값은 변경하는 값만 선택하여 입력하면 됩니다.

---

사용자를 제거하는 API입니다.

• URL

  /user/{userId}/delete

• Method:

  GET

• URL Params

  Required:

  userId

  string

  제거할 사용자의 "_id" 필드값

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    {
    	"result": "ok"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	result: "fail",
    	message: "not found",
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	result: "error",
    	message: "server fault"
    }
    

• Sample Call:

  Path: GET /user/is/duplicates?where=username&value=Lauren
  

• Notes:

  • 쿼리문자열 둘 다 필수사항입니다.

---

이메일과 유저네임 중복여부를 확인하는 API입니다.

• URL

  /user/is/duplicates

• Method:

  GET

• URL Params

  Required:

  where

  string

  중복여부를 확인할 필드명

  ["email", "username"]

  value

  string

  대조할 값

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    {
    	"result": "ok",
    	"message": "duplicates"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지, 요청이 성공한 경우 중복 여부["duplicates", "not duplicates""]

• Error Response:

  • Code: 405 INVALID PARAMETERS
    Content:

    {
    	result: "fail",
    	message: "invalid parameters",
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	result: "error",
    	message: "server fault"
    }
    

• Sample Call:

  Path: GET /user/is/duplicates?where=username&value=Lauren
  

• Notes:

  • 쿼리문자열 둘 다 필수사항입니다.

---

사용자가 작성한 리뷰 리스트를 반환합니다.

• URL

  /user/{userId}/comments

• Method:

  GET

• URL Params

  Required:

  userId

  사용자의 "_id" 필드값

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok",
    	"comments": [
    		...
    	]
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    comments

    Array<CommentModel>

    요청이 성공한 경우 작성한 리뷰 목록

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	"result": "fail",
    	"message": "not found"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  GET /user/599297a54a03b51a11aa3d27/comments
  

• Notes:

  None

---

사용자가 보유한 쿠폰 중, 사용 가능한 쿠폰 리스트를 반환합니다.

• URL

  /user/{userId}/coupons

• Method:

  GEt

• URL Params

  Required:

  userId

  string

  사용자의 "_id" 필드 값

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok",
    	"coupons": [
    		...
    	]
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    coupons

    Array<CouponModel>

    요청이 성공한 경우 쿠폰 리스트

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	"result": "fail",
    	"message": "not found"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  GET /user/599297a54a03b51a11aa3d27/coupons
  

• Notes:

  None

---

사용자의 장바구니에 제품을 추가합니다.

• URL

  /user/{userId}/add-bucket

• Method:

  POST

• URL Params

  REQUIRED:

  userId

  string

  사용자의 "_id" 필드값

• Data Params

  Body

  product

  string

  추가할 제품의 "_id" 필드값

  quantity

  integer

  제품의 수량

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	"result": "fail",
    	"message": "not found(user)"
    }
    

    {
    	"result": "fail",
    	"message": "not found(product)"
    }
    

  • Code: 405 INVALID PARAMETERS
    Content:

    {
    	"result": "fail",
    	"message": "invalid parameters"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  {
    "product": "...",
    "quantity": 1,
  }
  

• Notes:

  none

---

장바구니에 추가된 제품의 수량을 변경합니다.

• URL

  /user/{userId}/update-bucket

• Method:

  PUT

• URL Params

  REQUIRED:

  userId

  string

  사용자의 "_id" 필드값

• Data Params

  Body

  product

  string

  변경할 제품의 "_id" 필드값

  quantity

  integer

  변경될 수량

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	"result": "fail",
    	"message": "not found(user)"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  {
    "product": "...",
    "quantity": 3
  }
  

• Notes:

  • 장바구니에 product와 일치하는 제품이 없는 경우에는 200 응답을 반환하되, message에 "not updated: bucket has no matched product"가 전달됩니다.

---

장바구니에 추가된 제품을 제거합니다.

• URL

  /user/{userId}/delete-from-bucket

• Method:

  PUT

• URL Params

  REQUIRED:

  userId

  string

  사용자의 "_id" 필드값

• Data Params

  Body

  product

  string

  제거할 제품의 "_id" 필드값

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

• Error Response:

  • Code: 404 NOT FOUND
    Content:

    {
    	"result": "fail",
    	"message": "not found(user)"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  {
    "product": "..."
  }
  

• Notes:

  • 장바구니에 product와 일치하는 제품이 없는 경우에는 200 응답을 반환하되, message에 "not deleted: bucket has no matched product"가 전달됩니다.