[TIL] Week 7 프로젝트 2. 도서 판매 사이트 API 설계

🛠️ DB Diagram

ERD 자동 생성을 도와주는 사이트

dbdiagram.io - Database Relationship Diagrams Design Tool

좌측에 코드를 작성하면 우측에 ERD로 출력해준다. 

 

테이블 생성

Table 테이블명 {
  속성명 속성타입
}

PK나 AI 등과 같은 조건들도 함께 작성해줄 수 있다.

 

관계 설정

Ref 관계명: 테이블명1.속성명1 - 테이블명2.속석명2 // one-to-one

Ref 테이블명1.속성명1 > 테이블명2.속석명2 // many-to-one

Ref 테이블명1.속성명1 < 테이블명2.속석명2 // one-to-many

 

관계명은 생략 가능하며 두 속성을 - 혹은 부등호로 관계를 표현해준다.

• - : 일대일 관계
• > or < : 일대다 관계 (부등호 벌린쪽이 다)

 

 

✍🏻 API 설계

도서 판매 사이트의 API를 설계해보자.

 

회원 API

sample data

1. 회원 가입

Method	POST
URI	/join
HTTP status code	성공 201
RequestBody	{     email : “사용자가 입력한 이메일”,     password : “사용자가 입력한 비밀번호” }
ResponseBody

 

2. 로그인

Method	POST
URI	/login
HTTP status code	성공 200
RequestBody	{     email : “사용자가 입력한 이메일”,     password : “사용자가 입력한 비밀번호” }
ResponseBody	JWT Token

 

3. 비밀번호 초기화 요청

비밀번호를 초기화 하기 전 올바른 이메일인지 확인

Method	POST
URI	/reset
HTTP status code	성공 200
RequestBody	{     email : “사용자가 입력한 이메일” }
ResponseBody

 

4. 비밀번호 초기화 (= 수정)

Method	PUT
URI	/reset
HTTP status code	성공 200
RequestBody	{     password : “사용자가 입력한 비밀번호” }
ResponseBody

 

 

도서 API

sample data

1. 전체 도서 조회

Method	GET
URI	/books
HTTP status code	성공 200
RequestBody
ResponseBody	[     {           id : 도서 id,           title : “도서 제목”,           summary : “요약 설명”,           author : “도서 작가”,           price : 가격,           likes : 좋아요 수,           pubDate : “출간일”      },      {           id : 도서 id,           title : “도서 제목”,           summary : “요약 설명”,           author : “도서 작가”,           price : 가격,           likes : 좋아요 수,           pubDate : “출간일”      },      …. ]

 

2. 개별 도서 조회 

Method	GET
URI	/books/{bookId}
HTTP status code	성공 200
RequestBody
ResponseBody	[     {           id : 도서 id,           title : “도서 제목”,           category : “카테고리”,           format : “포맷”,           isbn : “isbn”,           summary : “요약 설명”,           description : “상세 설명”,           author : “도서 작가”,           pages : 쪽 수,           index : “목차”,           price : 가격,           likes : 좋아요 수,           liked : boolean,           pubDate : “출간일”      } ]

 

 

좋아요 API

sample data

1. 좋아요 추가

Method	POST
URI	/likes/{bookId}
HTTP status code	성공 200
RequestBody
ResponseBody

 

2. 좋아요 취소

Method	DELETE
URI	/likes/{bookId}
HTTP status code	성공 200
RequestBody
ResponseBody

 

 

 

장바구니 API

sample data

1. 장바구니 담기

Method	POST
URI	/cart
HTTP status code	성공 201
RequestBody	{     bookId : 도서 id,      count : 수량 }
ResponseBody

 

2. 장바구니 조회

Method	GET
URI	/cart
HTTP status code	성공 200
RequestBody	{     bookId : 도서 id,      count : 수량 }
ResponseBody	[     {           cartItemId : 장바구니 도서 id,           bookId : 도서 id,           title : “도서 제목”,           summary : “도서 요약”,           price : 가격,           count : 수량      },     {           cartItemId : 장바구니 도서 id,           bookId : 도서 id,           title : “도서 제목”,           summary : “도서 요약”,           price : 가격,           count : 수량      }, ]

 

3. 장바구니 도서 삭제

Method	DELETE
URI	/cart/{bookId}
HTTP status code	성공 200
RequestBody
ResponseBody

 

4. 장바구니에서 선택한 상품 목록 조회

Method	GET
URI	/ ..
HTTP status code	성공 200
RequestBody	[ cartItemId, cartItemId, … ]
ResponseBody	[     {           cartItemId : 장바구니 도서 id,           bookId : 도서 id,           title : “도서 제목”,           summary : “도서 요약”,           count : 수량,           price : 가격      },     {           cartItemId : 장바구니 도서 id,           bookId : 도서 id,           title : “도서 제목”,           summary : “도서 요약”,           count : 수량,           price : 가격      },     ... ]

* 장바구니에서 선택한 내용 즉, 아직 결제 전이기 때문에 주문 API가 아닌 장바구니 API

 

 

주문 API

sample data

1. 결제하기 = 주문하기 = 주문 등록 = 데이테베이스 주문 insert && 장바구니에서 주문한 상품은 delete

Method	POST
URI	/orders
HTTP status code	성공 200
RequestBody	{     items : [{           cart_item_id : 장바구니 도서 id,           book_id : 도서 id,           count : 수량      },      {           cart_item_id : 장바구니 도서 id,           book_id : 도서 id,           count : 수량      }      …      ],      delivery : {           address : “주소”,           receiver : “이름”,           contact : “010-0000-0000”      },      total_price : 총 금액 }
ResponseBody

 

2. 주문 목록(내역) 조회

Method	GET
URI	/orders
HTTP status code	성공 200
RequestBody	[     {           order_id : 주문 id,           created_at : “주문 일자”,           delivery : {                address : “주소”,                receiver : “이름,                contact : “전화번호”           },           bookTitle : “대표 책 제목”,           totalPrice : 결제 금액,           totalCount : 총 수량      } ]
ResponseBody

 

3. 주문 상세 상품 조회

Method	GET
URI	/orders/{orderId}
HTTP status code	성공 200
RequestBody
ResponseBody	[     {         bookId : 도서 id,         bookTitle : “도서 제목”,         author : “작가명”,         price : 가격,         count : 수량     },     {         bookId : 도서 id,         bookTitle : “도서 제목”,         author : “작가명”,         price : 가격,         count : 수량     },     ... ]