이 문서는 REST API를 구현한 JEEOKSHOP-ORDER API 사용 방법을 안내합니다.

개요

Http 동사

본 REST API에서 사용하는 HTTP 동사(verbs)는 가능한 표준 HTTP 와 REST 규약을 따릅니다.

동사 용례

동사	용례
`GET`	리소스를 가져올 때 사용
`POST`	새 리소스를 만들 때 사용
`PUT`	기존 리소스를 수정할 때 사용
`PATCH`	기존 리소스의 일부를 수정할 때 사용
`DELETE`	기존 리소스를 삭제할 떄 사용

GET

리소스를 가져올 때 사용

POST

새 리소스를 만들 때 사용

PUT

기존 리소스를 수정할 때 사용

PATCH

기존 리소스의 일부를 수정할 때 사용

DELETE

기존 리소스를 삭제할 떄 사용

HTTP 상태 코드

본 REST API에서 사용하는 HTTP 상태 코드는 가능한 표준 HTTP와 REST 규약을 따릅니다.

상태 코드 용례

상태 코드	용례
`200 OK`	요청을 성공적으로 처리함
`201 Created`	새 리소스를 성공적으로 생성함. 응답의 `Location` 헤더에 해당 리소스의 URI가 담겨있다.
`204 No Content`	기존 리소스를 성공적으로 수정함.
`400 Bad Request`	잘못된 요청을 보낸 경우. 응답 본문에 더 오류에 대한 정보가 담겨있다.
`404 Not Found`	요청한 리소스가 없음.
`409 Conflict`	클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우.

200 OK

요청을 성공적으로 처리함

201 Created

새 리소스를 성공적으로 생성함. 응답의 Location 헤더에 해당 리소스의 URI가 담겨있다.

204 No Content

기존 리소스를 성공적으로 수정함.

400 Bad Request

잘못된 요청을 보낸 경우. 응답 본문에 더 오류에 대한 정보가 담겨있다.

404 Not Found

요청한 리소스가 없음.

409 Conflict

클라이언트의 요청이 서버의 상태와 충돌이 발생한 경우.

기본 정보

Host : store.jeeokshop.jeeok.com

로그인 및 권한정보를 request header에 포함하여 인증

Key Value Description

Key	Value	Description
`Authorization`	`Bearer ${accessToken}`	로그인 후 리턴 받은 accessToken

Authorization

Bearer ${accessToken}

로그인 후 리턴 받은 accessToken

사용자 모드

사용자 화면에 사용됩니다.

주문

사용자는 상품을 선택 후 주문을 할 수 있고, 주문 목록 조회, 수정 및 취소 할 수 있습니다.

내 주문 목록

요청

GET //order.jeeokshop.jeeok.com/front/orders?searchMemberId&page=0&size=10&searchMemberId= HTTP/1.1
member-id: 1
Host: https

Parameter Description

Parameter	Description
`page`	검색 페이지
`size`	검색 사이즈

page

검색 페이지

size

검색 사이즈

응답

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2308

{"transaction_time":"2022-11-20T17:47:43.405223","code":"SUCCESS","message":null,"errors":null,"data":[{"orderId":4,"orderDate":"2022-11-20T17:47:43.1126748","orderStatus":"주문","orderItems":[{"orderItemId":7,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":8,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":6,"orderDate":"2022-11-20T17:47:43.1232881","orderStatus":"주문","orderItems":[{"orderItemId":11,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":12,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":8,"orderDate":"2022-11-20T17:47:43.1321421","orderStatus":"주문","orderItems":[{"orderItemId":15,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":16,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":10,"orderDate":"2022-11-20T17:47:43.1415687","orderStatus":"주문","orderItems":[{"orderItemId":19,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":20,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":12,"orderDate":"2022-11-20T17:47:43.1485431","orderStatus":"주문","orderItems":[{"orderItemId":23,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":24,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":14,"orderDate":"2022-11-20T17:47:43.1565366","orderStatus":"주문","orderItems":[{"orderItemId":27,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":28,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":16,"orderDate":"2022-11-20T17:47:43.1641632","orderStatus":"주문","orderItems":[{"orderItemId":31,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":32,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":18,"orderDate":"2022-11-20T17:47:43.172678","orderStatus":"주문","orderItems":[{"orderItemId":35,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":36,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":20,"orderDate":"2022-11-20T17:47:43.1803235","orderStatus":"주문","orderItems":[{"orderItemId":39,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":40,"itemId":1,"orderPrice":1000,"orderCount":1}]},{"orderId":22,"orderDate":"2022-11-20T17:47:43.1868125","orderStatus":"주문","orderItems":[{"orderItemId":43,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":44,"itemId":1,"orderPrice":1000,"orderCount":1}]}]}

Path Type Description

Path	Type	Description
`transaction_time`	`String`	api 요청 시간
`code`	`String`	SUCCESS or ERROR
`message`	`Null`	메시지
`errors`	`Null`	에러
`data[*].orderId`	`Number`	주문 고유번호
`data[*].orderDate`	`String`	주문 날짜
`data[*].orderStatus`	`String`	주문 상태
`data[].orderItems[].orderItemId`	`Number`	주문 상품 고유번호
`data[].orderItems[].itemId`	`Number`	상품 고유번호
`data[].orderItems[].orderPrice`	`Number`	주문 가격
`data[].orderItems[].orderCount`	`Number`	주문 수량

transaction_time

String

api 요청 시간

code

String

SUCCESS or ERROR

message

Null

메시지

errors

Null

에러

data[*].orderId

Number

주문 고유번호

data[*].orderDate

String

주문 날짜

data[*].orderStatus

String

주문 상태

data[*].orderItems[*].orderItemId

Number

주문 상품 고유번호

data[*].orderItems[*].itemId

Number

상품 고유번호

data[*].orderItems[*].orderPrice

Number

주문 가격

data[*].orderItems[*].orderCount

Number

주문 수량

내 주문 상세

요청

GET //order.jeeokshop.jeeok.com/front/orders/1 HTTP/1.1
Host: https

Table 1. /front/orders/{orderId}
Parameter	Description
`orderId`	주문 고유번호

응답

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 321

{"transaction_time":"2022-11-20T17:47:42.9084677","code":"SUCCESS","message":null,"errors":null,"data":{"orderId":1,"orderDate":"2022-11-20T17:47:42.3364166","orderStatus":"주문","orderItems":[{"orderItemId":1,"itemId":0,"orderPrice":1000,"orderCount":1},{"orderItemId":2,"itemId":1,"orderPrice":1000,"orderCount":1}]}}

Path Type Description

Path	Type	Description
`transaction_time`	`String`	api 요청 시간
`code`	`String`	SUCCESS or ERROR
`message`	`Null`	메시지
`errors`	`Null`	에러
`data.orderId`	`Number`	주문 고유번호
`data.orderDate`	`String`	주문 날짜
`data.orderStatus`	`String`	주문 상태
`data.orderItems[*].orderItemId`	`Number`	주문 상품 고유번호
`data.orderItems[*].itemId`	`Number`	상품 고유번호
`data.orderItems[*].orderPrice`	`Number`	주문 가격
`data.orderItems[*].orderCount`	`Number`	주문 수량

transaction_time

String

api 요청 시간

code

String

SUCCESS or ERROR

message

Null

메시지

errors

Null

에러

data.orderId

Number

주문 고유번호

data.orderDate

String

주문 날짜

data.orderStatus

String

주문 상태

data.orderItems[*].orderItemId

Number

주문 상품 고유번호

data.orderItems[*].itemId

Number

상품 고유번호

data.orderItems[*].orderPrice

Number

주문 가격

data.orderItems[*].orderCount

Number

주문 수량

주문

POST //order.jeeokshop.jeeok.com/front/orders HTTP/1.1
Content-Type: application/json;charset=UTF-8
member-id: 1
Content-Length: 103
Host: https

{"items":[{"itemId":0,"orderPrice":1000,"orderCount":1},{"itemId":1,"orderPrice":1000,"orderCount":1}]}

Path Type Description

Path	Type	Description
`items[*].itemId`	`Number`	상품 고유번호
`items[*].orderPrice`	`Number`	주문 가격
`items[*].orderCount`	`Number`	주문 수량

items[*].itemId

Number

상품 고유번호

items[*].orderPrice

Number

주문 가격

items[*].orderCount

Number

주문 수량

응답

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 120

{"transaction_time":"2022-11-20T17:47:43.4997191","code":"SUCCESS","message":null,"errors":null,"data":{"orderedId":24}}

Path Type Description

Path	Type	Description
`transaction_time`	`String`	api 요청 시간
`code`	`String`	SUCCESS or ERROR
`message`	`Null`	메시지
`errors`	`Null`	에러
`data.orderedId`	`Number`	주문된 주문 고유번호

transaction_time

String

api 요청 시간

code

String

SUCCESS or ERROR

message

Null

메시지

errors

Null

에러

data.orderedId

Number

주문된 주문 고유번호

주문 취소

요청

PUT //order.jeeokshop.jeeok.com/front/orders/2/cancel HTTP/1.1
Host: https

Table 2. /front/orders/{orderId}/cancel
Parameter	Description
`orderId`	주문 고유번호

응답

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 108

{"transaction_time":"2022-11-20T17:47:43.0427143","code":"SUCCESS","message":null,"errors":null,"data":null}

Path Type Description

Path	Type	Description
`transaction_time`	`String`	api 요청 시간
`code`	`String`	SUCCESS or ERROR
`message`	`Null`	메시지
`errors`	`Null`	에러
`data`	`Null`	데이터

transaction_time

String

api 요청 시간

code

String

SUCCESS or ERROR

message

Null

메시지

errors

Null

에러

data

Null

데이터

주문 삭제

요청

DELETE //order.jeeokshop.jeeok.com/front/orders/3 HTTP/1.1
Host: https

Table 3. /front/orders/{orderId}
Parameter	Description
`orderId`	주문 고유번호

응답

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 108

{"transaction_time":"2022-11-20T17:47:43.0896775","code":"SUCCESS","message":null,"errors":null,"data":null}

Path Type Description

Path	Type	Description
`transaction_time`	`String`	api 요청 시간
`code`	`String`	SUCCESS or ERROR
`message`	`Null`	메시지
`errors`	`Null`	에러
`data`	`Null`	데이터

transaction_time

String

api 요청 시간

code

String

SUCCESS or ERROR

message

Null

메시지

errors

Null

에러

data

Null

데이터

JEEOKSHOP-ORDER : REST API