프로젝트 2&3 API들 설계하기

ssomae·2024년 9월 27일

DevCourse

목록 보기
23/29
post-thumbnail

프로젝트 API 설계해보기

회원 API

1. 회원가입

MethodPOST
URI/join
HTTP status code성공 201
Request body(
email : “사용자가 입력한 이메일”
password : “사용자가 입력한 비밀번호”
)
Response body

2. 로그인

MethodPOST
URI/login
HTTP status code성공 200
Request body(
email : “사용자가 입력한 이메일”
password : “사용자가 입력한 비밀번호”
)
Response bodyJWT token

3. 비밀번호 초기화 요청

MethodPOST
URI/reset
HTTP status code성공 200
Request body(
email : “사용자가 입력한 이메일”
)
Response body

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

MethodPUT
URI/reset
HTTP status code성공 200
Request body(
email : “사용자가 입력한 이메일”
)
Response body

도서 API 설계

1. 전체 도서 조회 (이미지 주소 8개씩 보내줘야함)

MethodGET
URI/books
HTTP status code성공 200
Request body
Response body(
id : 도서 id,
img : “img URL”,
title : “도서 제목”,
summary : “요약 설명”,
author : “도서 작가”
price : 가격,
likes : 좋아요 수
pubDate : “출간일”
)

2. 개별 도서 조회 (이미지 경로)

MethodGET
URI/books/(bookId)
HTTP status code성공 200
Request body
Response body(
id : 도서 id,
img : “img URL”,
title : “도서 제목”,
category : “카테고리”,
format : “포맷”,
ISBN : “isbn”,
summary : “요약 설명”,
description : “상세 설명”
author : “도서 작가”
paged : 쪽 수,
index : “목차”
price : 가격,
likes : 좋아요 수,
liked : boolean,
pubDate : “출간일”)

3. 카테고리별 도서 목록 조회(이미지 경로 고려해야함) (with queryString)

MethodGET
URI/books?catregoryId = (categoryId) & new = “boolean”
HTTP status code성공 200
Request body
Response body
id : 도서 id,
img : “img URL”,
title : “도서 제목”,
summary : “요약 설명”,
author : “도서 작가”
price : 가격,
likes : 좋아요 수
pubDate : “출간일”
)

좋아요 API

좋아요 추가

MethodPUT
URI/likes/(bookId)
HTTP status code성공 200
Request body
Response body

좋아요 취소

MethodPUT
URI/likes/(bookId)
HTTP status code성공 200
Request body
Response body

장바구니 API

1. 장바구니 담기

MethodPOST
URI/cart
HTTP status code성공 201
Request body(
bookId : 도서 id,
count : 수량

) |
| Response body | |

2. 장바구니 조회

MethodGET
URI/cart
HTTP status code성공 200
Request body
Response body[
(
cartItemId : 장바구니 도서 id,
bookId : 도서 id,
title : “도서 제목”,
summary : “도서 요약”,
count : 수량,
price : 가격
),
(
cartItemId : 장바구니 도서 id,
bookId : 도서 id,
title : “도서 제목”,
summary : “도서 요약”,
count : 수량,
price : 가격
)
]

3. 장바구니 도서 제거

MethodDELETE
URI/cart/(bookid)
HTTP status code성공 200
Request body
Response body

결제 API

업로드중..

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

MethodGET
URI/
HTTP status code성공 200
Request body
Response body[
(
cartItemId : 장바구니 도서 id,
bookId : 도서 id,
title : “도서 제목”,
summary : “도서 요약”,
count : 수량,
price : 가격
),
(
cartItemId : 장바구니 도서 id,
bookId : 도서 id,
title : “도서 제목”,
summary : “도서 요약”,
count : 수량,
price : 가격
)
]
profile
성장해나갈 개발자

0개의 댓글