🎯 모든 API를 최종적으로 정리합니다.

📙 Today I Learned

프로젝트 구조

MVC 패턴을 활용하여 요청을 처리하고 비즈니스 로직을 수행하도록 구성하였습니다.

📦BOOK-SHOP/  
├── 📂controller/          #  요청을 받아 비즈니스 로직을 호출  
│   ├── BookController.js  
│   ├── CartController.js  
│   ├── CategoryController.js  
│   ├── LikeController.js  
│   ├── OrderController.js  
│   └── UserController.js  
│  
├── 📂service/             #  비즈니스 로직을 처리  
│   ├── BookService.js  
│   ├── CartService.js  
│   ├── CategoryService.js  
│   ├── LikeService.js  
│   ├── OrderService.js  
│   └── UserService.js  
│  
├── 📂model/               #  데이터베이스 모델 정의  
│   ├── Book.js  
│   ├── Cart.js  
│   ├── Category.js  
│   ├── Like.js  
│   ├── Order.js  
│   └── User.js  
│  
├── 📂routes/              #  라우터 설정  
│   ├── books.js  
│   ├── carts.js  
│   ├── categories.js  
│   ├── likes.js  
│   ├── orders.js  
│   └── users.js  
│  
├──📂validation/           #  요청 데이터 검증  
│   ├── bookValidation.js  
│   ├── cartValidation.js  
│   ├── categoryValidation.js  
│   ├── likeValidation.js  
│   ├── orderValidation.js  
│   └── userValidation.js  
│  
│  
├── .env                 #  환경 변수 
├── app.js               #  Express 애플리케이션 초기화  
├── auth.js              #  인증 관련 로직  
├── mariadb.js           #  데이터베이스 연결  
├── package.json         #  프로젝트 의존성  
└── package-lock.json    #  패키지 버전 관리  

MVC 패턴

소프트웨어를 모델(Model), 뷰(View), 컨트롤러(Controller)로 나누어 구조화하는 디자인 패턴입니다.

• Model : 데이터베이스와 관련된 로직을 담당합니다.

• View : 사용자에게 보이는 UI를 담당합니다. (API 프로젝트이므로 뷰가 따로 없음)

• Controller : 클라이언트의 요청을 받아 모델과 뷰를 연결하는 역할.

---

MYSQL 페이지네이션 구현

1️⃣ LIMIT & OFFSET 사용하는 방법입니다.

SELECT * FROM Bookshop.books LIMIT 4 OFFSET 0;
SELECT count(*) FROM Bookshop.books;

2️⃣ SQL_CALC_FOUND_ROWS를 활용하는 방법입니다.

SELECT SQL_CALC_FOUND_ROWS * FROM Bookshop.books LIMIT 4 OFFSET 0;
SELECT found_rows();

👎 하지만 성능이 떨어지므로 대량의 데이터에서는 사용하지 않는 것이 좋습니다.

---

회원 API

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

회원 가입

• Method : POST

• URL : /users/join

• HTTP Status Code : 201 Created

• Request Body

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

• Response Body : x

로그인

• Method : POST

• URL : /users/login

• HTTP Status Code : 200 Ok

• Request Body

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

• Response Cookie : JWT Token

비밀번호 초기화 요청

• Method : POST

• URL :/users/rest

• HTTP Status Code : 200 Ok

• Request Body

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

• Response Body

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

비밀번호 초기화

• Method : PUT

• URL : /users/rest

• HTTP Status Code : 200 Ok

• Request Body

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

• Response Body : x

---

좋아요 API

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

좋아요 추가

• Method : POST

• URL : /likes/:bookId

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Response Body : x
  

좋아요 취소

• Method : DELETE

• URL : /likes/:bookId

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Response Body : x

---

도서 API

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

전체 도서 조회

• Method : GET

• URL :/books?limit=개수&currentPage=페이지번호

• HTTP Status Code : 200 Ok

• Response Body :

{
  "books" : [
    {
      "id" : 도서 id,
      "title": "도서 제목",
      "img" : 이미지 id,
      "summary" : "요약 설명",
      "author" : "도서 작가",
      "price" : 가격,
      "likes" : 좋아요 수,
      "pubDate" : "출간 날짜"
    },
    {
      "id" : 도서 id,
      "title": "도서 제목",
      "img" : 이미지 id,
      "summary" : "요약 설명",
      "author" : "도서 작가",
      "price" : 가격,
      "likes" : 좋아요 수,
      "pubDate" : "출간 날짜"
    },
    ...
  ],
  "pagination": {
  	"currentPage": 현재 페이지,
    "totalCount": 총 도서 수
  }
}

개별 도서 조회

• Method : GET

• URL : /books/:id

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Response Body :

{
  "id" : 도서 id,
  "title": "도서 제목",
  "img" : 이미지 id,
  "categoryName" : "카테고리",
  "form" : "포맷",
  "isbn" : "isbn",  
  "summary" : "요약 설명",
  "detail" : "자세한 설명",
  "author" : "도서 작가",
  "pages" : 쪽 수,
  "contents" : "목차",
  "price" : 가격,
  "likes" : 좋아요 수,
  "liked" : boolean, (로그인인 상태에만 보내줌)
  "pubDate" : "출간 날짜"
}

카테고리별 신간 도서 조회

• Method : GET

• URL : /books?categoryId=:categoryId&news={boolean}

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

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

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

---

장바구니 API

장바구니 담기

• Method : POST

• URL : /carts

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Request Body

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

• Response Body : x

장바구니 조회 / 선택 상품 조회(주문서 작성)

• Method : GET

• URL : /carts

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Request Body :

{
   "selected" : [cartItemId, cartItemId ...]
}

• Response Body

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

장바구니 삭제

• Method : DELETE

• URL : /carts/:cartItemId

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Request Body : x

• Response Body : x

---

주문(결제) API

주문하기

• Method : POST

• URL : /orders

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Request Body

{
  "items": [ 장바구니 도서 id, 장바구니 도서 id, ...],
  "delivery" : {
    	"address" : "주소",
    	"receiver" : "이름",
    	"contact" : "전화번호"
  },
  "totalQuantity" : 총 수량,
  "totalPrice" : 총 금액,
  "firstbookTitle" : "대표 도서 제목"
}

• Response Body : x

주문 목록 조회

• Method : GET

• URL : /orders

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Response Body :

[
  {
    "orderId" : 주문 id,
  	"createdAt" : "주문일자",
    "address" : "주소",
    "receiver" : "이름",
    "contact" : "전화번호",
  	"bookTitle" : "대표 책 제목",
    "totalQuantity" : 총 수량,
  	"totalPrice" : 결제 금액,

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

주문 상세 조회

• Method : GET

• URL : /orders/:id

• HTTP Status Code : 200 Ok

• Request Headers : 'Authorization' : JWT Token

• Response Body :

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

---

✏️ 한 줄 회고

백엔드 개발 강의가 끝났다는 게 실감이 안 나고, MVC 패턴을 활용해서 코드를 정리하는 과제를 독학해서 잘 마무리해야겠습니다!!