API 명세서(수정)

API 명세서

멤버	음식점	메뉴	평점	주문
member	store	item	likes	order

---

member

Members	Descriptions
POST /api/members/signup	멤버 등록
GET /api/members	전체 멤버 조회
GET /api/members/{memberId}	멤버 상세 조회

store

Stores	Descriptions
GET /api/stores	전체 상점 조회

order

Orders	Descriptions
POST /api/orders	주문
GET /api/orders	주문전체조회
GET /api/orders/{orderId}	주문상세조회

Likes

Likes	Descriptions
POST /api/likes	평점

멤버 등록 POST /api/members/signup

• 멤버를 추가합니다.

Request

{
    "name":"yeongmin4",
    "address":"seoul"
}

Response

{
    "success": true,
    "data": {
        "name": "yeongmin4",
        "address": "seoul",
        "createdAt": "2022-11-26T10:28:16.107923",
        "modifiedAt": "2022-11-26T10:28:16.107923",
        "id": 4
    },
    "error": null
}

전체멤버조회 GET /api/members

• 멤버 전체를 보여줍니다.

Response

{
    "success": true,
    "data": [
        {
            "name": "yeongmin1",
            "address": "seoul",
            "createdAt": null,
            "modifiedAt": null,
            "id": 1
        },
        {
            "name": "yeongmin2",
            "address": "seoul",
            "createdAt": null,
            "modifiedAt": null,
            "id": 2
        },
        {
            "name": "yeongmin3",
            "address": "seoul",
            "createdAt": null,
            "modifiedAt": null,
            "id": 3
        }
    ],
    "error": null
}

멤버상세조회 GET /api/members/{memberId}

• 멤버 상세를 보여줍니다.

Response

{
    "success": true,
    "data": {
        "name": "yeongmin1",
        "address": "seoul",
        "createdAt": null,
        "modifiedAt": null,
        "id": 1
    },
    "error": null
}

전체상점조회 GET /api/stores

• 상점 전체를 보여줍니다.

Response

{
    "success": true,
    "data": [
        {
            "createdAt": "2022-11-18T22:25:32.570953",
            "modifiedAt": "2022-11-18T22:25:32.570953",
            "id": 1,
            "name": "명동왕족",
            "address": "jecheon-si",
            "category": "JOCKBAL",
            "avgStar": 0.0,
            "items": [
                {
                    "createdAt": "2022-11-18T22:25:44.445495",
                    "modifiedAt": "2022-11-18T22:25:44.445495",
                    "orderHasItems": [
                        {
                            "amount": 0,
                            "id": 1
                        },
                        {
                            "amount": 3,
                            "id": 2
                        },
                        {
                            "amount": 3,
                            "id": 3
                        }
                    ]
                },
                {
                    "createdAt": "2022-11-18T22:25:44.462958",
                    "modifiedAt": "2022-11-18T22:25:44.462958",
                    "orderHasItems": [
                        {
                            "amount": 3,
                            "id": 4
                        }
                    ]
                }
            ],
            "likes": []
        }
}

주문 생성 POST /api/orders

• 주문을 생성합니다.

Request

{
    "storeId":1,
    "itemId":[1,2],
    "memberId":1,
    "amount":[5,3],
    "storeName":"Macdonalds"
}

Response

{
    "success": true,
    "data": {
        "storeId": 2,
        "itemId": [
            1,
            2,
            3
        ],
        "amount": [
            5,
            4,
            4
        ],
        "memberId": 3,
        "createdAt": "2022-11-26T10:42:52.249986"
    },
    "error": null
}

주문 전체 조회 GET /api/orders

• 주문 전체를 보여줍니다.

Response

{
    "success": true,
    "data": [
        {
            "ordersId": 1,
            "memberId": 2,
            "orderDate": "2022-11-26T00:29:24.681756",
            "storeName": "Macdonalds",
            "orderHasItems": [
                {
                    "itemName": "족발",
                    "amount": 5
                },
                {
                    "itemName": "족발",
                    "amount": 4
                },
                {
                    "itemName": "족발",
                    "amount": 4
                }
            ]
        },
        {
            "ordersId": 2,
            "memberId": 2,
            "orderDate": "2022-11-26T00:35:59.854717",
            "storeName": "Macdonalds",
            "orderHasItems": [
                {
                    "itemName": "족발",
                    "amount": 5
                },
                {
                    "itemName": "족발",
                    "amount": 4
                },
                {
                    "itemName": "족발",
                    "amount": 4
                }
            ]
        },
       ...
    ],
    "error": null
}

주문 상세 조회 GET /api/orders/{ordersId}

• 주문 상세를 보여줍니다.

Response

{
    "success": true,
    "data": {
        "ordersId": 3,
        "memberId": 1,
        "orderDate": "2022-11-26T00:37:49.303372",
        "storeName": "Macdonalds",
        "orderHasItems": [
            {
                "itemName": "족발",
                "amount": 4
            },
            {
                "itemName": "족발",
                "amount": 5
            },
            {
                "itemName": "족발",
                "amount": 4
            }
        ]
    },
    "error": null
}

평점 입력 POST /api/likes

• 가게에 대한 평점을 입력합니다.
• Response의 data는 random하게 생성된 평점을 의미합니다.

Request

{
    "memberId":1,
    "storeId":1
}

Response

{
    "success": true,
    "data": 3,
    "error": null
}