Shop

가게 도메인 API 명세

가게 등록

가게 등록

POST http://localhost:8080/shops/regist

가게를 등록할 수 있도록 합니다.

Headers

Name	Type	Description
token*	String	로그인 시 발급받은 JWT

Request Body

Name	Type	Description
shopName*	String	가게 이름
shopAddress*	String	가게 주소
brandName*	String	브랜드 이름
tip*	String	가게 배달팁
description*	String	가게 설명

200: OK 가게 등록 성공

{
    "success": true,
    "response": null,
    "error": null
}

401: Unauthorized 인증되지 않았을 때

{
    "success": false,
    "response": null,
    "error": {
        "message": "인증되지 않았습니다.",
	"status": 401
    }
}

400: Bad Request 잘못된 요청

{
    "success": false,
    "response": null,
    "error": {
        "message": "잘못된 요청입니다.",
	"status": 400
    }
}

500: Internal Server Error 서버의 알 수 없는 에러

{
    "success": false,
    "response": null,
    "error": {
        "message": "서버의 알 수 없는 에러입니다.",
        "status": 500
    }
}

가게 조회

가게 조회

GET http://localhost:8080/shops/{id}

가게 정보를 조회할 수 있도록 합니다.

단순히 가게를 조회하는 것은 별도의 인증 절차를 거치지 않습니다.

200: OK 가게 조회 성공

{
    "success": true,
    "response": {
        "idx": 1,
        "userName": "김기태",
        "shopName": "굽네치킨 부산안락점",
        "description": "한자리에서 여기까지 왔...",
        "shopAddress": "부산광역시 동래구 안락동 AB",
        "image": "https://postfiles.pstatic.net/MjAyMDA5MDdfMjM2/MDAxNTk5NDUwMDU3MTMx.R3LJwbRiMdZcwnqlJ4nRG5EbSi8KLyYMBdbgbw95dHog.VKCpNcHkFkAGL8bGiZTAM8zWyoGJtVvVA0tz7s-y82wg.JPEG.gaonnuri51/Untitled-1.jpg?type=w966",
        "starPoint" 4,
        "orderCount": 1244,
        "reviewCount": 2,
        "menus": [
            {
                "idx": 1,
                "menuName": "고추바사삭",
                "options": [
                    {
                        "idx": 1,
                        "optionName": "뼈치킨",
                        "price": 19000
                    },
                    {
                        "idx": 2,
                        "optionName": "콜라 라지 변경",
                        "price": 2000
                    }
                ]
            },
            {
                "idx" 2,
                "menuName": "볼케이노",
                "options": [
                    {
                        "idx": 1,
                        "optionName": "뼈치킨",
                        "price": 19000
                    },
                    {
                        "idx": 2,
                        "optionName": "콜라 라지 변경",
                        "price": 2000
                    }
                ]
            }
        ],
        "reviews": [
        {
            "idx": 1,
            "content": "맛은 있는데 배달이 넘 느리네요..",
            "startPoint": 3,
            "userName": "MinseokGo",
            "createAt": "2023-08-03"
        },
        {
            "idx": 2,
            "content": "맛있습니다!",
            "startPoint": 5,
            "userName": "kimikitae",
            "createAt": "2023-08-04"
        } ]
    },
    "error": null
}

404: Not Found 해당 가게를 찾을 수 없을 때

{
    "success": false,
    "response": null,
    "error": {
        "message": "해당 가게를 찾을 수 없습니다.",
        "status": 404
    }
}

400: Bad Request 잘못된 요청

{
    "success": false,
    "response": null,
    "error": {
        "message": "해당 요청은 잘못되었습니다.",
        "status": 400
    }
}

500: Internal Server Error 서버의 알 수 없는 에러

{
    "success": false,
    "response": null,
    "error": {
        "message": "서버의 알 수 없는 에러입니다.",
        "status": 500
    }
}

가게 정보 수정

가게 정보 수정

PUT http://localhost:8080/shops/update

가게 정보를 수정할 수 있도록 합니다.

Headers

Name	Type	Description
token*	String	로그인 시 발급받은 JWT

Request Body

Name	Type	Description
newName*	String	새로운 가게 이름
newAddress*	String	새로운 주소
newTip*	String	새로운 배달팁
idx*	String	가게의 고유 아이디
newDescription*	String	새로운 가게 설명

200: OK 가게 정보 수정 성공

{
    "success": true,
    "response": null,
    "error": null
}

400: Bad Request 잘못된 요청

{
    "success": false,
    "response": null,
    "error": {
        "message": "해당 요청은 잘못되었습니다.",
        "status": 400
    }
}

401: Unauthorized 인증되지 않았을 때

{
    "success": false,
    "response": null,
    "error": {
        "message": "인증되지 않았습니다.",
	"status": 401
    }
}

500: Internal Server Error 서버의 알 수 없는 에러

{
    "success": false,
    "response": null,
    "error": {
        "message": "서버의 알 수 없는 에러입니다.",
        "status": 500
    }
}

가게 삭제

가게 삭제

DELETE http://localhost:8080/shops/unregist

가게 삭제를 할 수 있도록 합니다.

Headers

Name	Type	Description
token*	String	로그인 시 발급받은 JWT

Request Body

Name	Type	Description
idx*	String	가게의 고유 ID

200: OK 가게 삭제 성공

{
    "success": true,
    "response": null,
    "error": null
}

400: Bad Request 잘못된 요청

{
    "success": false,
    "response": null,
    "error": {
        "message": "해당 요청은 잘못되었습니다.",
        "status": 400
    }
}

401: Unauthorized 인증되지 않았을 때

{
    "success": false,
    "response": null,
    "error": {
        "message": "인증되지 않았습니다.",
	"status": 401
    }
}

500: Internal Server Error 서버의 알 수 없는 에러

{
    "success": false,
    "response": null,
    "error": {
        "message": "서버의 알 수 없는 에러입니다.",
        "status": 500
    }
}

404: Not Found 해당 가게를 찾을 수 없을 때

{
    "success": false,
    "response": null,
    "error": {
        "message": "해당 가게를 찾을 수 없습니다.",
        "status": 404
    }
}