🎯 도서 API와 카테고리 API를 설계하고 구현합니다.

📙 Today I Learned

데이터베이스 수정

TABLE books

Table books {
  id integer [primary key]
  title varchar
  img integer
  category_id integer
  form varchar
  isbn varchar
  summary text
  detail text
  author varchar
  pages integer
  contents text
  price integer
  likes integer
  pub_date date
}

🤔 도서 이미지 링크는 어떻게 받을까?

Lorem Picsum(샘플 이미지🖼️가 필요할 때 URL 기반 요청으로 무료 이미지를 제공하는 서비스)을 활용해서 이미지의 주소값을 int값으로 활용할 예정입니다.
👉 Lorem Picsum 사이트

• https://picsum.photos/200/300 → 200x300 크기의 랜덤 이미지 제공

TABLE categories

Table categories {
  id integer [primary key]
  category_name varchar
}

---

도서 API 설계

전체 도서 조회

• Method : GET

• URL : /books

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

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

• TODO : 데이터를 8개씩 보여주기는 추후에 고도화할 예정입니다.

개별 도서 조회

• Method : GET

• URL : /books/:id

• HTTP Status Code : 200 Ok

• Request Body

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

• Response Body :

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

카테고리별 신간 도서 조회

• Method : GET

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

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

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

• TODO : 데이터를 8개씩 보여주기는 추후에 고도화할 예정입니다.

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

---

카테고리 API 설계

카테고리별 전체 조회

• Method : GET

• URL : /category

• HTTP Status Code : 200 Ok

• Request Body : x

• Response Body :

[
  {
    "id" : 카테고리 id,
    "name": "카테고리 이름",  
  },
  {
    "id" : 카테고리 id,
    "name": "카테고리 이름",
  },
  ...
]

---

BookController.js

const conn = require('../mariadb');
const { StatusCodes } = require('http-status-codes');

const allBooks = (req, res) => {
  const { categoryId } = req.query;

  if (categoryId) {
    const sql = 'SELECT * FROM books WHERE category_id = ?';
    conn.query(sql, categoryId, (err, result) => {
      if (err) {
        return res.status(StatusCodes.BAD_REQUEST).end();
      }
      if (result.length) {
        return res.status(StatusCodes.OK).json(result);
      } else {
        return res.status(StatusCodes.NOT_FOUND).end();
      }
    });
  } else {
    const sql = 'SELECT * FROM books';
    conn.query(sql, (err, result) => {
      if (err) {
        return res.status(StatusCodes.BAD_REQUEST).end();
      }

      return res.status(StatusCodes.OK).json(result);
    });
  }
};

const bookDetail = (req, res) => {
  const id = parseInt(req.params.id);

  const sql = 'SELECT * FROM books WHERE id = ?';
  conn.query(sql, id, (err, result) => {
    if (err) {
      console.log(err);
      return res.status(StatusCodes.BAD_REQUEST).end();
    }

    if (result[0]) {
      return res.status(StatusCodes.OK).json(result);
    } else {
      return res.status(StatusCodes.NOT_FOUND).end();
    }
  });
};

module.exports = {
  allBooks,
  bookDetail,
};

• allBooks : categoryId가 있을 경우 특정 카테고리의 도서 조회하고, 없으면 전체 조회합니다.

• bookDetail : 특정 도서의 상세 정보를 조회합니다.

---

✏️ 한 줄 회고

같은 엔드포인트를 여러 컨트롤러로 나누기보다 하나의 컨트롤러에서 categoryId 존재 여부에 따라 나누는 것이 더 깔끔하고 잘 돌아가는 것이라는 것을 깨달았습니다.