Skip to content

회원 API Docs

Seongwon Choi edited this page Oct 14, 2024 · 1 revision

Customer Save

HTTP request

POST /api/v1/customers HTTP/1.1
Content-Type: application/json
Content-Length: 161
Host: localhost:8080

{"email":"[email protected]","password":"Password1!","name":"user","nickname":"nickname","birthDate":"1999-01-29","phoneNumber":"010-1234-5678","provider":"KAKAO"}

HTTP response

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

{"accessToken":"accessToken"}

Customer Save OAuth

Http Request

POST /api/v1/customers/oauth HTTP/1.1
Content-Type: application/json
Content-Length: 90
Host: localhost:8080

{"nickname":"nickname","birthDate":"1999-01-29","phoneNumber":"010-1234-5678","oAuthId":1}

Http Response

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

{"accessToken":"accessToken"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 29

{"accessToken":"accessToken"}

Menu Save

Http Request

POST /menus HTTP/1.1
Content-Type: application/json
Content-Length: 148
Host: localhost:8080

{"id":1,"name":"name","price":"1000","imageUrl":"imageUrl","menuOptionName":"best_seller","description":"description","verifyAge":false,"storeId":1}

Http Response

HTTP/1.1 200 OK

Order Save

Http Request

POST /api/v1/orders?_csrf=ysW5u8ERgiR0NyVLSCVSi48YBoSMIJTu6vYoteB8S3CEeLId__ffjPkmtBJZB0R_cAhmvLh6K-bvGfXDiZMeg9EZe0mzGYMq HTTP/1.1
Content-Type: application/json
Content-Length: 204
Host: localhost:8080

{"customerId":1,"orderItems":[],"store":{"createdDate":null,"lastModifiedDate":null,"id":1,"name":"storeName","phoneNumber":"010-1234-5678","time":{"open":"12:00:00","close":"22:00:00"},"storeImages":[]}}

Http Response

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

{"id":null,"store":{"createdDate":null,"lastModifiedDate":null,"id":1,"name":"storeName","phoneNumber":"010-1234-5678","time":{"open":"12:00:00","close":"22:00:00"},"storeImages":[]},"orderInfo":null,"totalPrice":0,"payment":null}

Payment Find One

Http Request

GET /api/v1/payments/1?_csrf=tyWEsRCbGIXcz1e1YwxqgMDoYMJTO-Hc9JMCuLuahLyYAyPehUe0gCn4fbDx_GWGViFet6TfTaNiCdbxxaVn24v54oj7N0a9 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

Http Response

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

{"id":1,"amount":1000,"status":"COMPLETE","payMethod":"CARD","payType":"KB"}

Payment Fail

Http Request

GET /api/v1/payment/fail?code=PAY_PROCESS_CANCELED&message=%EC%82%AC%EC%9A%A9%EC%9E%90%EC%97%90+%EC%9D%98%ED%95%B4+%EA%B2%B0%EC%A0%9C%EA%B0%80+%EC%B7%A8%EC%86%8C%EB%90%98%EC%97%88%EC%8A%B5%EB%8B%88%EB%8B%A4.&orderId=7381695799855143&_csrf=6tHwpWLBMu8_WLAaQuSkpfL7vxiSF18AkPmx5YhPvRg7yTLU3bKWwwT4UIwSOtR8d8mQxsrDkiCncWkt8cnU17kqiikM8FG3 HTTP/1.1
Content-Type: application/json
Host: localhost:8080

Http Response

HTTP/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 95

{"message":"사용자에 의해 결제가 취소되었습니다.","orderId":"7381695799855143"}

Store Save

Http Request

POST /api/v1/stores HTTP/1.1
Content-Type: application/json
Content-Length: 179
Host: localhost:8080

{"id":1,"name":"storeName","phoneNumber":"010-1234-5678","mainAddress":"서울시 강남구 역삼동","detailAddress":"12-234","openTime":"12:00","closeTime":"22:00","images":[]}

Http Response

HTTP/1.1 204 No Content

Store Find All

HTTP request

GET /api/v1/stores?latitude=37.6531852873842&longitude=127.04778768624769 HTTP/1.1
Host: localhost:8080

HTTP response

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

[{"name":"store1","imageUrl":["image1"]},{"name":"store2","imageUrl":["image1"]}]

Store Find One

HTTP request

GET /api/v1/stores/1 HTTP/1.1
Host: localhost:8080

HTTP response

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

{"storeName":"store1","phoneNumber":"010-1234-5678","address":"서울시 강남구 역삼동12-2","images":["imageUrl1","imageUrl2"],"menuInfos":[{"menuName":"menu1","price":"10000","description":"description","imageUrl":"image","label":"BEST_SELLER","verifyAge":true}]}