Search
📂

API 명세서

Key-Value로 표시된 Request 데이터 형식 (form-data)
Search
API
구분
이름
method
URL
request
response
권한
Postman
유저
로그인
Open
POST
/
AccessToken, RefreshToken
X
유저
프로필 수정
Open
PATCH
/v1/users
Key - Value (form-data) multipartFile - images.jpg req - {"userId":6,"username":"창선님바이","introduction":"창선님이제주무셔요"}
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "email": "vu00@naver.com", "username": "창선님바이", "introduction": "창선님이제주무셔요", "profileImageUrl": "https://jyp-delivery-bucket.s3.ap-northeast-2.amazonaws.com/profile/9cffc7df-7648-4e2b-aced-3d0ea861d0a9.png" } }
ALL
유저
프로필 조회
Open
GET
/v1/users
{ "userId" : 6 }
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "email": "vud0@naver.com", "username": "창선님하이", "introduction": "창선님퇴근축하", "profileImageUrl": "https://jyp-delivery-bucket.s3.ap-northeast-2.amazonaws.com/profile/9cffc7df-7648-4e2b-aced-3d0ea861d0a9.png" } }
ALL
주문
주문 생성
Open
POST
/v1/orders
{ "orderSaveReqs" : [ { "menuId" : 1, "amount" : 3 }, { "menuId" : 2, "amount" : 4 } ] }
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "orderId": 1, "username": "창선님하이", "totalPrice": 29000, "orderSaveReses": [ { "menuName": "짜장", "amount": 3, "price": 9000 }, { "menuName": "짬뽕", "amount": 4, "price": 20000 } ] } }
USER
주문
주문 단건 조회
Open
GET
/v1/orders
{ "orderId" : 1 }
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "shopName": "스파르타 짬뽕", "orderId": 1, "username": "창선님하이", "totalPrice": 29000, "orderGetReses": [ { "menuName": "짜장", "amount": 3, "price": 9000 }, { "menuName": "짬뽕", "amount": 4, "price": 20000 } ] } }
ALL
주문
사용자 주문 내역 조회
Open
GET
/v1/orders/users
{ }
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "orderGetResWrappers": [ { "shopName": "스파르타 짬뽕", "orderId": 1, "username": "창선님하이", "totalPrice": 29000, "orderGetReses": [ { "menuName": "짜장", "amount": 3, "price": 9000 }, { "menuName": "짬뽕", "amount": 4, "price": 20000 } ] }, { "shopName": "스파르타 짬뽕", "orderId": 2, "username": "창선님하이", "totalPrice": 29000, "orderGetReses": [ { "menuName": "짜장", "amount": 3, "price": 9000 }, { "menuName": "짬뽕", "amount": 4, "price": 20000 } ] } ], "total": 2 } }
USER
주문
가게 주문 내역 조회
Open
GET
/v1/orders/shops
{ "shopId" : 1 }
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "orderGetResWrappers": [ { "shopName": "스파르타 짬뽕", "orderId": 1, "username": "창선님하이", "totalPrice": 29000, "orderGetReses": [ { "menuName": "짜장", "amount": 3, "price": 9000 }, { "menuName": "짬뽕", "amount": 4, "price": 20000 } ] }, { "shopName": "스파르타 짬뽕", "orderId": 2, "username": "창선님하이", "totalPrice": 29000, "orderGetReses": [ { "menuName": "짜장", "amount": 3, "price": 9000 }, { "menuName": "짬뽕", "amount": 4, "price": 20000 } ] } ], "total": 2 } }
ADMIN
주문
주문 취소
Open
DELETE
/v1/orders
{ "orderId": 1 }
{ "code": 0, "message": "정상 처리 되었습니다", "data": {} }
ALL
리뷰
리뷰 생성
Open
POST
/v1/reviews
{"shopId" : 1, "content" : "불맛이 너무 좋아요" }
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "username": "창선님하이", "content": "불맛이 너무 좋아요" } }
USER
리뷰
리뷰 삭제
Open
DELETE
/v1/reviews
{    "reviewId" : "4",    "username" : "chaplk"}
{    "code": 0,    "message": "정상 처리 되었습니다",    "data": {        "reviewId": null    }}
USER
리뷰
리뷰 수정
Open
PATCH
/v1/reviews
{"reviewId" : 5, "shopId" : 1,"content" : "면발이 좋아","username":"chaplk"}
{    "code": 0,    "message": "정상 처리 되었습니다",    "data": {        "username": "chaplk",        "content": "면발이 좋아"    }}
USER
리뷰
가게 전체 리뷰 내역 조회
Open
GET
/v1/reviews/shops
{ “shopId”: 1 }
{    "code": 0,    "message": "정상 처리 되었습니다",    "data": [        {            "shopId": 1,            "username": "Test",            "content": "살려줘",            "imageUrl": null        },        {            "shopId": 1,            "username": "Test",            "content": "살려줘",            "imageUrl": "https://ysp-delivery.s3.ap-northeast-2.amazonaws.com/review/e32ea69d-8459-49b3-9f11-0580c8213166.png"        },        {            "shopId": 1,            "username": "Test",            "content": "살려줘",            "imageUrl": "https://ysp-delivery.s3.ap-northeast-2.amazonaws.com/review/4511795c-6b2b-48c6-8557-25805bead8d6.png"        }    ]}
X
리뷰
유저 전체 리뷰 내역 조회
Open
GET
/v1/reviews/users
{ }
{    "code": 0,    "message": "정상 처리 되었습니다",    "data": [        {            "shopId": 1,            "username": "chaplk",            "content": "불맛이 너무 좋아요",            "imageUrl": "https://ysp-delivery.s3.ap-northeast-2.amazonaws.com/review/0a80873f-571e-4b2d-b114-a87f28d80ef0.png"        }    ]}
가게
가게 전체 조회
Open
GET
/v1/shops
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "shopGetReses": [ { "shopId": 1, "shopName": "스파르타 짬뽕", "description": "짬뽕도 팝니다", "location": "서울특별시 강남구 테헤란로44길 8", "callNumber": "02-5678-1234", "like": 0, "menuGetReses": [ { "menuId": 1, "imageUrl": null, "menuName": "짜장", "price": 3000 }, { "menuId": 2, "imageUrl": null, "menuName": "짬뽕", "price": 5000 } ] }, { "shopId": 2, "shopName": "스파르타 짜장", "description": "코딩클럽 아닙니다", "location": "서울특별시 강남구 테헤란로44길 8", "callNumber": "02-1234-5678", "like": 0, "menuGetReses": [] } ], "total": 2 } }
X
가게
가게 단건 조회
Open
GET
/v1/shops/{shopId}
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "shopId": 1, "shopName": "스파르타 짬뽕", "description": "짬뽕도 팝니다", "location": "서울특별시 강남구 테헤란로44길 8", "callNumber": "02-5678-1234", "like": 0, "menuGetReses": [ { "menuId": 1, "imageUrl": null, "menuName": "짜장", "price": 3000 }, { "menuId": 2, "imageUrl": null, "menuName": "짬뽕", "price": 5000 } ] } }
X
가게
가게 좋아요
Open
POST
/v1/shops/like
{    "shopId" : 1,    "isLike" : true}
{ "code": 0, "message": "정상 처리 되었습니다", "data": {} } { "code": 4000, "message": "이미 좋아요가 눌린 가게입니다.", "data": null } { "code": 4001, "message": "아직 좋아요를 누르지 않은 가게입니다.", "data": null }
USER
가게
가게 추가
Open
POST
/v1/admin/shops
{ "shopName" : "스파르타 짜장", "description" : "코딩클럽 아닙니다", "location" : "서울특별시 강남구 테헤란로44길 8", "callNumber" : "02-1234-5678" }
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "shopName": "스파르타 짜장", "description": "코딩클럽 아닙니다", "location": "서울특별시 강남구 테헤란로44길 8", "callNumber": "02-1234-5678" } }
ADMIN
가게
가게 수정
Open
PATCH
/v1/admin/shops
{ "shopId" : 1, "shopName" : "스파르타 짬뽕", "description" : "짬뽕도 팝니다", "location" : "서울특별시 강남구 테헤란로44길 8", "callNumber" : "02-5678-1234" }
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "shopName": "스파르타 짬뽕", "description": "짬뽕도 팝니다", "location": "서울특별시 강남구 테헤란로44길 8", "callNumber": "02-5678-1234" } }
ADMIN
가게
가게 삭제
Open
DELETE
/v1/admin/shops
{ "shopId" : 1 }
{ "code": 0, "message": "정상 처리 되었습니다", "data": {} }
ADMIN
메뉴
메뉴 단건 조회
Open
GET
/v1/menus/{menuId}
{    "code": 0,    "message": "정상 처리 되었습니다",    "data": {        "menuName": "짜장",        "imageUrl": null,        "price": 3000    }}
X
메뉴
메뉴 추가
Open
POST
/v1/admin/menus
Key - Value (form-data) multipartFile - image.jpg addMenuReq - {"menuName" : “짜장면", "price" : "3000", "shopId" : "1"}
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "menuId": 1, "imageUrl": null, "menuName": "menuName", "price": 3000, "shopId": null } }
ADMIN
메뉴
메뉴 수정
Open
PATCH
/v1/admin/menus
Key - Value (form-data) multipartFile - image.jpg addMenuReq - {”menuId” : 1, "menuName" : "짬뽕", "price" : "5000", "shopId" : "1"}
{ "code": 0, "message": "정상 처리 되었습니다", "data": { "menuId": 1, "imageUrl": null, "menuName": "짬뽕", "price": 5000, "shopId": null } }
ADMIN
메뉴
메뉴 삭제
Open
DELETE
/v1/admin/menus
{ "menuId" : 1, "shopId" : 1 }
{ "code": 0, "message": "정상 처리 되었습니다", "data": {} }
ADMIN
Made with