🎯 도서 구매 사이트 화면을 통해 API를 설계합니다.

📙 Today I Learned

회원 API 설계

회원 가입

• Method : POST

• URL : /join

• HTTP Status Code : 201 Created

• Request Body

  {
    "email": "사용자가 입력한 이메일",
    "password" : "사용자가 입력한 비밀번호"
  }

• Response Body : x

로그인

• Method : POST

• URL : /login

• HTTP Status Code : 200 Ok

• Request Body

  {
    "email": "사용자가 입력한 이메일",
    "password" : "사용자가 입력한 비밀번호"
  }

• Response Body : JWT Token

비밀번호 초기화 요청

• Method : POST

• URL : /rest

• HTTP Status Code : 200 Ok

• Request Body

  {
    "email": "사용자가 입력한 이메일"
  }

• Response Body : x

비밀번호 초기화

• Method : PUT

• URL : /rest

• HTTP Status Code : 200 Ok

• Request Body

  {
    "email": "사용자가 입력한 이메일"
  }

• Response Body : x

---

도서 API 설계

전체 도서 조회

• Method : GET

• URL : /books

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

[
  {
    "id" : 도서 id,
    "title": "도서 제목",
    "summary" : "요약 설명",
    "author" : "도서 작가",
    "price" : 가격,
    "likes" : 좋아요 수,
    "pubDate" : "출간 날짜"
  },
  {
    "id" : 도서 id,
    "title": "도서 제목",
    "summary" : "요약 설명",
    "author" : "도서 작가",
    "price" : 가격,
    "likes" : 좋아요 수,
    "pubDate" : "출간 날짜"
  },
  ...
]

• TODO : 이미지 주소 전달, 데이터를 8개씩 보내주어야 하는 것은 추후에 고도화할 예정입니다.

개별 도서 조회

• Method : GET

• URL : /books/:id

• HTTP Status Code : 200 Ok

• Request Body

{
  "email": "사용자가 입력한 이메일",
  "password" : "사용자가 입력한 비밀번호"
}

• Response Body :

{
  "id" : 도서 id,
  "title": "도서 제목",
  "category" : "카테고리",
  "format" : "포맷",
  "isbn" : "isbn",  
  "summary" : "요약 설명",
  "author" : "도서 작가",
  "pages" : 쪽 수,
  "index" : "목차",
  "price" : 가격,
  "likes" : 좋아요 수,
  "liked" : boolean,
  "pubDate" : "출간 날짜"
}

• TODO : 이미지 주소 전달은 추후에 고도화할 예정입니다.

카테고리별 신간 도서 조회

• Method : GET

• URL : /books?category=:category&new={boolean}

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

[
  {
    "id" : 도서 id,
    "title": "도서 제목",
    "summary" : "요약 설명",
    "author" : "도서 작가",
    "price" : 가격,
    "likes" : 좋아요 수,
    "pubDate" : "출간 날짜"
  },
  {
    "id" : 도서 id,
    "title": "도서 제목",
    "summary" : "요약 설명",
    "author" : "도서 작가",
    "price" : 가격,
    "likes" : 좋아요 수,
    "pubDate" : "출간 날짜"
  },
  ...
]

• TODO : 이미지 주소 전달, 데이터를 8개씩 보내주어야 하는 것은 추후에 고도화할 예정입니다.

• 참고사항 : new가 true일 때 신간 조회 기준은 출간일로부터 30일 이내

---

좋아요 API 설계

좋아요 추가

• Method : PUT

• URL : /likes/:id

• HTTP Status Code :200 Ok

• Request Body : x

• Response Body : x

• TODO : 추후 api 수정 예정
  

좋아요 취소

• Method : PUT

• URL : /likes/:id

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body : x

• TODO : 추후 api 수정 예정
  

---

장바구니 API 설계

장바구니 담기

• Method : POST

• URL : /cart

• HTTP Status Code : 200 Ok

• Request Body

  {
    "bookId" : 도서 id,
    "count" : 수량
  }

• Response Body : x

장바구니 조회

• Method : GET

• URL : /cart

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body

 [
  { 
    "cartItem" : 장바구니 id,
    "bookId" : 도서 id,
    "title" : "도서 제목",
    "summary" : "요약 설명",
    "count" : 수량,
    "price" : 가격
  },
  {
    "cartItem" : 장바구니 id,
    "bookId" : 도서 id,
    "title" : "도서 제목",
    "summary" : "요약 설명",
    "count" : 수량,
    "price" : 가격
  },
 ]

장바구니 삭제

• Method : DELETE

• URL : /cart/:id

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body : x

---

주문 API 설계

주문서 작성

• Method : GET

• URL : /cart

• HTTP Status Code : 200 Ok

• Request Body

• Response Body : x

[
  {
    "cartItem" : 장바구니 id,
    "bookId" : 도서 id,
    "title" : "도서 제목",
    "summary" : "요약 설명",
    "count" : 수량,
    "price" : 가격
  },
  {
    "cartItem" : 장바구니 id,
    "bookId" : 도서 id,
    "title" : "도서 제목",
    "summary" : "요약 설명",
    "count" : 수량,
    "price" : 가격
  },
]

• TODO : 추후 api 수정 예정
  

---

✏️ 한 줄 회고

ERD(엔터티 관계 다이어그램) 없이 화면만을 보고 API를 설계하는 것이 매우 어렵다는 것을 느꼈습니다. 😅