http接口说明模板

一 一 查询菜品列表接口查询菜品列表接口 DONE 1 1 功能说明 功能说明 接受提供的菜品 XXX 画面 XXX 功能 比如人口查询画面 查询 人口查询画面 详细 等 2 2 接口调用说明 接口调用说明 2 1 获取地址获取地址 http 192 168 0 6 8080 FamilyServiceSystem BookDinnerQueryAction operation q ueryServiceItem 2 2http 请求方式请求方式 GET 2 3 数据返回格式数据返回格式 JSON 2 4 传递参数传递参数 参数名称参数名称是否是否 必须必须 类型类型示例示例描述描述 page是是String1获取第几个分页的菜获取第几个分页的菜 品 默认第一个分页品 默认第一个分页 为为 1 pageSize是是String5每页显示多少个菜品 每页显示多少个菜品 默认为默认为 5 isFood是是Stringtrue查询食物还是饮料 查询食物还是饮料 查询食物为查询食物为 true 饮料为饮料为 false 饮料和食物为空饮料和食物为空 2 5 成功返回结果成功返回结果 serverResponse Success totalRecords 52 page 10 pageSize 5 data id 123 itemName 皇堡 priceNow 10 pricePast 12 servicePicture s9118668 jpg serviceStars 3 id itemName priceNow pricePast servicePicture s9118668 jpg serviceStars 3 2 6 返回结果解释返回结果解释 参数名称参数名称类型类型描述描述备注备注 pageString当前返回的是当前返回的是 第几页第几页 idInt菜品编号 itemName String菜品名字 priceNow String现价 pricePast String原价 servicePicture String菜品图片 serviceStarsString菜品星级 二 查询广告接口二 查询广告接口 DONE 1 1 功能说明 功能说明 接受广告图片 目前为一张 2 2 接口调用说明 接口调用说明 2 1 获取地址获取地址 http 192 168 0 6 8080 FamilyServiceSystem BookDinnerQueryAction operation q ueryAdvertisePicture 2 2http 请求方式请求方式 GET 2 3 数据返回格式数据返回格式 JSON 2 4 传递参数传递参数 参数名称参数名称是否是否 必须必须 类型类型示例示例描述描述 facilitatorID是是String000000平台广告 商家平台广告 商家 ID 值固定为值固定为 000000 2 5 成功返回结果成功返回结果 serverResponse Success advertisePicture 0f736a68b929b0955b319ebc41336 jpg 2 6 返回结果解释返回结果解释 参数名称参数名称类型类型描述描述备注备注 advertisePictureString餐厅图片名称 三 查询订单列表接口三 查询订单列表接口 DONE 1 1 功能说明 功能说明 根据指定的客户 id 查询订单 2 2 接口调用说明 接口调用说明 2 1 获取地址获取地址 http 192 168 0 6 8080 FamilyServiceSystem BookDinnerQueryAction operation q ueryServiceOrderList 2 2http 请求方式请求方式 GET 2 3 数据返回格式数据返回格式 JSON 2 4 传递参数传递参数 参数名称参数名称是否必须是否必须类型类型描述描述 customerID是string提供客户 id orderStatus否String提供查询条件 不传该字段时查询所有状态的订 单 参数说明 这个接口可以作为多种用途 搜索正在进行中的订单 customerID 和 orderStatus 2 5 成功返回结果成功返回结果 serverResponse Success data orderNo 02135 orderTime 11 00 orderStatus 评价完毕 paidAmount 30 2 6 返回结果解释返回结果解释 参数