菜品数据接口 ¶

菜品列表 ¶

查询当前商户全部菜品列表

请求

基本
HTTP URL	https://macromap.cxkjedu.com/api/open/dishes
HTTP Method	GET

请求头

名称	类型	必填	描述
Content-Type	string	是	固定值："application/json; charset=utf-8"
open-token	string	是	`app_api_token` 示例值："d13fc57d46bac217" 了解更多：获取访问凭证 api_token

查询参数

该请求无请求参数

请求体

该请求无请求体

请求体示例

$ curl --location --request GET 'https://macromap.cxkjedu.com/api/open/dishes' \
--header 'content-type:application/json; charset=utf-8' \
--header 'open-token: d13fc57d46bac217'

响应体

名称	类型	描述
status	string	接口状态 SUCCESS 表示成功
code	int	响应代码 200 表示成功
msg	string	错误描述
data	dish[]	菜品列表
∟ id	int	菜品 ID
∟ name	string	菜品名称
∟ price	float	菜品价格
∟ stock	int	菜品库存
∟ unit	string	菜品单位
∟ category_id	int	菜品分类 ID
∟ user_id	int	商户 ID
∟ created_at	string	创建时间
∟ updated_at	string	修改时间

响应体示例

{
    "status": "SUCCESS",
    "code": 200,
    "data": [
        {
            "id": 1,
            "name": "清泉玉女瓜",
            "price": 19,
            "stock": 0,
            "category_id": 10,
            "user_id": 3,
            "created_at": "2022-03-22 09:13",
            "updated_at": "2022-09-24 15:24",
            "unit": "碗"
        },
        {
            "id": 2,
            "name": "这是一个菜鸡",
            "price": 19,
            "stock": 99999,
            "category_id": 10,
            "user_id": 3,
            "created_at": "2022-03-22 09:13",
            "updated_at": "2022-09-24 15:24",
            "unit": "锅"
        },
        {
            "id": 4,
            "name": "菜狗",
            "price": 2,
            "stock": 99,
            "category_id": 10,
            "user_id": 3,
            "created_at": "2022-03-23 10:19",
            "updated_at": "2022-08-14 16:31",
            "unit": null
        }
    ]
}

菜品信息 ¶

查询菜品信息

请求

基本
HTTP URL	https://macromap.cxkjedu.com/api/open/dishes/:dish_id
HTTP Method	GET

请求头

名称	类型	必填	描述
Content-Type	string	是	固定值："application/json; charset=utf-8"
open-token	string	是	`app_api_token` 示例值："d13fc57d46bac217" 了解更多：获取访问凭证 api_token

查询参数

名称	类型	必填	描述
dish_id	string	是	菜品 ID 示例值："1"

请求体

该请求无请求体

请求体示例

$ curl --location --request GET 'https://macromap.cxkjedu.com/api/open/dishes/1' \
--header 'content-type:application/json; charset=utf-8' \
--header 'open-token: d13fc57d46bac217'

响应体

名称	类型	描述
status	string	接口状态 SUCCESS 表示成功
code	int	响应代码 200 表示成功
msg	string	错误描述
data	data	菜品数据
∟ id	int	菜品 ID
∟ name	string	菜品名称
∟ price	float	菜品价格
∟ stock	int	菜品库存
∟ unit	string	菜品单位
∟ category_id	int	菜品分类 ID
∟ user_id	int	商户 ID
∟ created_at	string	创建时间
∟ updated_at	string	修改时间

响应体示例

{
    "status": "SUCCESS",
    "code": 200,
    "data": {
        "id": 1,
        "name": "清泉玉女瓜",
        "price": 19,
        "stock": 0,
        "category_id": 10,
        "user_id": 3,
        "created_at": "2022-03-22 09:13",
        "updated_at": "2022-09-24 15:24",
        "unit": "碗"
    }
}