目录

• 接口文档 当前版本号: v2.0
  • 管理系统
    • 获取补货信息(admin)[改]
    • 根据box完成补货[新]
    • 完成补货信息(admin)[保留v1接口]

v1版本接口链接

接口文档 当前版本号: v2.0

统一url前缀: {{ server_ip }}/api/{{ current_version}}

统一响应体:
    {
        data : json数据包,
        code : 自定义业务代码,
        msg : 响应信息
    }

(user)/(admin)登录需要:
    在请求的header中加入: { Authorization : "JWT token值"}

管理系统

获取补货信息(admin)[改]

描述: 获取待补货信息  按照盒子定位 有详细补货信息条目
url: /admin/supplements
请求方式: GET
传入参数:
            无

返回值:
    正常情况:
        response: {
            data: [
                {
                    "box_id" : 1,
                    "apartment_name" : "xx楼",
                    "room" : "123",
                    "sup_details" : [
                        {
                            "gs_id" : 23,
                            "g_name" : "薯片",
                            "supplement" : 8       // 待补充数量
                        },
                        {
                            "gs_id" : 3,
                            "g_name" : "薯片",
                            "supplement" : 18       // 待补充数量
                        }
                    ]
                },
                {
                    "box_id" : 13,
                    "apartment_name" : "xx楼",
                    "room" : "123",
                    "sup_details" : [
                        {
                            "gs_id" : 23,
                            "g_name" : "薯片",
                            "supplement" : 8       // 待补充数量
                        },
                    ]
                }
            ],
            code : 0,
            msg : "请求成功"
        }


    错误情况:
        code   msg              data(null)
        4101  "验证头信息错误"/"Token有误"/"未提供认证token"/"token超时"/"无效的token"
        4001  "数据库未找到"(管理员)
        4000  "数据库操作错误"
        4500  "内部错误"

根据box完成补货[新]

描述: 获取待补货信息  根据单条补货记录补货
url: /admin/supplements/box
请求方式: POST
传入参数:
        名称          类型        是否必须             说明
        b_id         int          是               盒子id

返回值:
    正常情况:
        response: {
            data: {
                "b_id" : 21,
                "sup_detail_ids" : [1, 2, 4, 5]         // 补货记录的id
            },
            code : 0,
            msg : "请求成功"
        }
        
    错误情况:
        code   msg              data(null)
        4101  "验证头信息错误"/"Token有误"/"未提供认证token"/"token超时"/"无效的token"
        4001  "数据库未找到"(管理员/没有box/box没有待补充的商品)
        4000  "数据库操作错误"

完成补货信息(admin)[保留v1接口]

描述: 获取待补货信息  根据单条补货记录补货
url: /admin/supplements
请求方式: POST
传入参数:
        名称          类型        是否必须             说明
        gs_id         int          是               补货信息id

返回值:
    正常情况:
        response: {
            data: {
                "gs_id" : 21
            },
            code : 0,
            msg : "请求成功"
        }


    错误情况:
        code   msg              data(null)
        4101  "验证头信息错误"/"Token有误"/"未提供认证token"/"token超时"/"无效的token"
        4001  "数据库未找到"(管理员)
        4000  "数据库操作错误"