[데브코스] BOOK STORE 프로젝트 API 설계(1)

이제 본격적으로 진짜 프로젝트라고 할만한걸 시작하는 것 같다. 아직 프론트 커리큘럼은 시작을 안해서 API만 우선 만드는 듯? 프론트 없는 프로젝트라니 너무 어색하고 어색함. 오늘은 API 설계를 해보았다.

---

회원 API

회원가입
Method	POST
URL	/join
HTTP status code	성공: 201 실패: 400
Request Body	{      email: "user_email",      password: "user_password" }
Response Body

로그인
Method	POST
URL	/login
HTTP status code	성공: 200 실패: 400(잘못된 요청)          401(권한 x)
Request Body	{      email: "user_email",      password: "user_password" }
Response Body	JWT Token

비밀번호 초기화 요청
Method	POST
URL	/user
HTTP status code	성공: 200 실패: 400(잘못된 요청)          401(권한 x)
Request Body	{     email: "user_email" }
Response Body	JWT Token

비밀번호 초기화
Method	PUT
URL	/user
HTTP status code	성공: 200 실패: 400
Request Body	{    password: "user_password" }
Response Body

회원 삭제
Method	DELETE
URL	/user/{user_id}
HTTP status code	성공: 200 실패: 400
Request Body
Response Body

 

도서 API

전체 도서 조회
Method	GET
URL	/books
HTTP status code	성공 200
Request Body
Response Body	[    {         title: "도서 제목",         summary: "요약 설명",         author: "도서 작가",         price: "가격",         likes: "좋아요 수",         pubDate: "출간 날짜"    }    {         title: "도서 제목",         summary: "요약 설명",         author: "도서 작가",         price: "가격",         likes: "좋아요 수",         pubDate: "출간 날짜"    } ]

개별 도서 조회
Method	GET
URL	/books/{id}
HTTP status code	성공: 200
Request Body
Response Body	[    {        id: "도서 id",        title: "도서 제목",        category: "카테고리",        format: "포맷",        isbn: "isbn",        summary: "요약 설명",        author: "도서 작가",        pages: "쪽수",        description: "상세 설명",        index : "목차",        price: "가격",        likes: "좋아요 수",        liked: boolean,        pubDate: "출간 날짜"    } ]

카테고리별 도서 목록 조회
Method	GET
URL	/books?categoryId={categoryId}&new={boolean}
HTTP status code	성공: 200
Request Body
Response Body	[    {         title: "도서 제목",         summary: "요약 설명",         author: "도서 작가",         price: "가격",         likes: "좋아요 수",         pubDate: "출간 날짜"    } ]

 

 

좋아요 API

좋아요 추가
Method	PUT
URL	/likes/{bookId}
HTTP status code	성공: 200 실패: 404
Request Body
Response Body

좋아요 취소
Method	PUT
URL	/likes/{bookId}
HTTP status code	성공: 200 실패: 404
Request Body
Response Body

 

 

장바구니 API

장바구니 담기
Method	POST
URL	/cart
HTTP status code	성공: 201 실패: 404
Request Body	{     bookId: 도서 Id,     count: 수 }
Response Body

장바구니 조회
Method	GET
URL	/cart
HTTP status code	성공: 200
Request Body
Response Body	[    {         bookId: 도서 id,         title: "도서 제목",         summary: "도서 요약",         count: 수량,         price: 가격    }    {         bookId: 도서 id,         title: "도서 제목",         summary: "도서 요약",         count: 수량,         price: 가격    } ]

장바구니 도서 삭제
Method	DELETE
URL	/cart/{bookId}
HTTP status code	성공: 200 실패: 404
Request Body
Response Body

 

 

주문 API

주문 등록
Method	POST
URL	/order
HTTP status code	성공: 201 실패: 404
Request Body	{      orderId: "장바구니 id" }
Response Body

장바구니에서 선택한 주문 상품 목록 조회
Method	GET
URL	/order/{userId}
HTTP status code	성공: 200 실패: 404
Request Body
Response Body	[    {         cartItemId: 장바구니 도서 id,         bookId: 도서 id,         title: "도서 제목",         summary: "도서 요약",         count: 수량,         price: 가격    }    {         cartItemId: 장바구니 도서 id,         bookId: 도서 id,         title: "도서 제목",         summary: "도서 요약",         count: 수량,         price: 가격    } ]

 

---

주제가 썩 마음에 들지는 않는다. 도서 쇼핑몰인 것 같은데, 결제 API를 붙일 게 아닌데 장바구니에 주문서 확인 기능까지 들어가야 하나 싶다가도 학습이 우선이니 CRUD 숙달을 위해서라도 뭐든 기능 하나 더 있으면 좋은 것 같기도 하고. 사실 그냥 쇼핑몰 프로젝트인게 맘에 안들어서 장바구니 기능도 마음에 안드는 것 같음. 나만의 서재 느낌으로 해보고 싶은데 맘대로 하면 안되겠징 끝나고 리팩토링 해봐야겠다.

우선 강의에 따라 설계를 진행했는데, API 설계를 더 세분화 할 필요가 있는 것 같다.