Public
Documentation Settings
No Environment
Double Column
cURL - cURL
캣코독
Introduction
POST
회원가입
POST
로그인
GET
제품목록 조회(필터링,정렬,검색)
GET
장바구니 조회
POST
장바구니에 제품 추가
PATCH
장바구니의 제품 수량 변경, 제품 삭제
DEL
사용자 장바구니 전체삭제

캣코독

POST회원가입

http://백엔드서버IP주소:8000/users/signup

회원가입 기능 API

  • 유효성 검사
    • 이메일: email@google.com, 계정, @, 상위도메인, 점, 하위도메인 반드시 포함돼야함
    • 비밀번호: 8~16자 제한으로 영문 대문자 또는 소문자, 숫자, 특수기호 각 1개 이상 반드시 입력되야 함
    • 핸드폰번호: 10자리 또는 11자리 숫자
    • 회원이름: 한글이름만으로 한 글자 이상, 자음/모음만 넣으면 안됨
    • 유효하지 않은 값이나 중복되는 이메일 또는 핸드폰번호로 가입할 시 백엔드서버쪽에서 오류 메시지가 뜨지만 리스폰스는 보내지 않음
Bodyraw (json)
json
{
    "name": "위코더",
    "email": "wecoder@naver.com",
    "password": "qwer1234#",
    "mobile_number": "010-1212-1234",
    "address": "서울 강남구",
    "email_subscription": "True",
    "pet_type": "1"
}

POST로그인

http://백엔드서버IP주소:8000/users/signin

로그인 기능 API

  • 로그인 시도
    • 이메일, 비밀번호 검증
    • 성공하면 JWT 토큰 발급
    • 토큰 만료시간은 1일이고 변경 가능
  • 로그인 실패
    • 이메일 또는 비밀번호 불일치

테스트용 토큰값(유효기간 10일, 세영)

http 헤더에 "Authorization" 이라는 key 와 아래 value가 있어야함

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MiwiZXhwIjoxNjU0ODYyMDQ2fQ.nexZmfT6tth344VjCnNJJdHcTXo_EYkopvaapz6QbO8

Bodyraw 
{
    "email": "qwer@gmail.com",
    "password": "qwert@12"
}

GET제품목록 조회(필터링,정렬,검색)

http://10.58.7.96:8000/products?category=dog

StartFragment

제품 목록 조회 API

http 리퀘스트

  • 카테고리 이름을 쿼리 파라미터로(category) 받아서 카테고리별 제품 조회(dog,cat,meat,frozen 등)

  • 제품명 검색어를 쿼리 파라미터로(search) 받아서 검색기능 구현

  • 제품명 검색을 할 경우 카테고리별 제품으로는 할 수 없고 모든 제품이 검색 대상이 됨

  • 정렬 조건을 쿼리 파라미터로(sort) 받아서 정렬기능 구현

  • sort 입력값 목록

    • "new" : 신상품순
    • "old" : 오래된순
    • "name": 가나다순(이름순)
    • "-name": 이름 역순
    • "price" : 가격순(오름차순)
    • "-price" : 가격순(내림차순)
    • "review" : 제품후기 많은순
    • "sales" : 판매량 많은순

  • 페이징 처리 쿼리 파라미터(offset, limit)

    • offset 입력 없으면 기본값은 0
    • limit 입력 없으면 기본값은 6
    • 한 페이지에 6개를 보여준다면, 다음 페이지로 넘어가는 동작을 할때 offset값을 6을 넣어주면 다음 순서가 나옴
    • 페이징시 인덱스값 변경 [0:6] 페이징-> [6:12]
    • 또는 limit 값을 올릴수도 있음
    • [0:6] 페이징-> [0:12]

http 리스폰스

  • 제품id, 제품명 등 필요한 정보
PARAMS
category

dog

GET장바구니 조회

http://백엔드서버주소:8000/orders/cart

장바구니 조회

로그인한 사용자의 장바구니 조회

  • http 헤더에 토큰이 들어있어야 함

  • 리퀘스트 : get 서버주소/orders/cart

  • 헤더의 토큰에 있는 사용자 식별정보로 장바구니 데이터를 조회하고 필요한 데이터 출력

  • 출력 :

    • 카트 id
    • 제품명
    • 제품옵션 id
    • 제품옵션명
    • 제품옵션의 썸네일 url
    • 제품옵션의 가격
    • 제품옵션의 수량
    • 제품옵션별 주문금액(가격 X 수량)
    • 총 주문금액
    • 배송비(무료, 유료 3000원)
    • 무료배송 여부
AUTHORIZATIONAPI Key
Key

Authorization

Value

<value>

Loading