🎯 ERD를 설계하며 API를 수정합니다.

📙 Today I Learned

어제 작성했던 API를 수정하고, ERD를 작성합니다.

👉 수정한 부분은 주황색 글씨로 나타냅니다.

회원 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?categoryId=:categoryId&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 : POST

• URL : /likes/:bookId

• HTTP Status Code :200 Ok

• Request Body : x

• Response Body : x

좋아요 취소

• Method : DELETE

• URL : /likes/:bookId

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body : x
  

---

장바구니 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

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

장바구니 삭제

• Method : DELETE

• URL : /cart/:cartItemId

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body : x

주문 예상 상품 목록 조회(주문서 작성)

• Method : GET

• URL : /추후 결정

• HTTP Status Code : 200 Ok

• Request Body

[ cartItemId, cartItemId, ... ]

• Response Body : x

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

• TODO : 추후 api 수정

---

주문(결제) API 설계

결제하기

• Method : POST

• URL : /orders

• HTTP Status Code : 200 Ok

• Request Body

{
  "item": [
    {
    	"cartItemId" : 장바구니 도서 id,
      	"bookId" : 도서 id,
      	"count" : 수량
    },
    {
    	"cartItemId" : 장바구니 도서 id,
      	"bookId" : 도서 id,
      	"count" : 수량
    }  
  ],
  "delivery" : {
    	"address" : "주소",
    	"receiver" : "이름",
    	"contact" : "전화번호"
  },
  "totalPrice" : 금액
}

• Response Body : x

주문 목록 조회

• Method : GET

• URL : /orders

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

[
  {
    "order_id" : 주문 id,
  	"created_at" : "주문일자",
    "delivery" : {
    	"address" : "주소",
     	"receiver" : "이름",
    	"contact" : "전화번호",
    },
  	"bookTitle" : "대표 책 제목",
  	"totalPrice" : 결제 금액,
  	"totalCount" : 총 수량
  },
  {
    "order_id" : 주문 id,
  	"created_at" : "주문일자",
    "delivery" : {
    	"address" : "주소",
     	"receiver" : "이름",
    	"contact" : "전화번호",
  },
  	"bookTitle" : "대표 책 제목",
  	"totalPrice" : 결제 금액,
  	"totalCount" : 총 수량
  },
  ...
]

주문 상세 조회

• Method : GET

• URL : /orders/:id

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

[
  {
    "bookId" : 도서 id,
    "bookTitle" : "도서 제목",
    "author" : "작가",
    "price" : 가격,
    "count" : 수량
  },
  {
    "bookId" : 도서 id,
    "bookTitle" : "도서 제목",
    "author" : "작가",
    "price" : 가격,
    "count" : 수량
  },
  ...
]

---

ERD 작성

Table users {
  id integer [primary key]
  email varchar
  password varchar
}

Table books {
  id integar [primary key]
  title varchar
  category varchar
  format varchar
  isbn varchar
  summary text
  description text
  author varchar
  pages integer
  index text
  price integer
  likes integer
  pubDate timestamp
}

Table likes {
  user_id integer 
  liked_book_id integer
}

Table cartItems {
  id integer [primary key]
  book_id integer
  count integer
}

Table deliveries {
  id integer [primary key]
  address varchar
  receiver varchar
  contact varchar
}

Table orders {
  id integer [primary key]
  delivery_id integer
  total_price integer
  created_at timestamp
  book_title varchar
  total_count integer
}

Table orderedBook {
  order_id integer
  book_id integer
  count integer
}

ref: orderedBook.order_id > orders.id
ref: orderedBook.book_id > books.id
ref: orders.delivery_id > deliveries.id
ref: cartItems.book_id > books.id
ref: likes.user_id > users.id
ref: likes.liked_book_id > books.id

---

✏️ 한 줄 회고

ERD를 같이 설계해보니 데이터 흐름이 더 명확해지고, API 설계 방향도 한눈에 잘 보이는 느낌이었습니다.