http接口说明模板.docx

一、 查询菜品列表接口(DONE)1、功能说明接受提供的菜品XXX画面XXX功能（比如人口查询画面-查询 | 人口查询画面-详细等）2、接口调用说明2.1获取地址:8080/FamilyServiceSystem/BookDinnerQueryAction?operation=queryServiceItem2.2http请求方式GET2.3数据返回格式JSON2.4传递参数参数名称是否必须类型示例描述page是String1获取第几个分页的菜品，默认第一个分页为1pageSize是String5每页显示多少个菜品，默认为5isFood是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菜品编号itemNameString菜品名字priceNowString现价pricePastString原价servicePictureString菜品图片serviceStarsString菜品星级二、查询广告接口（DONE）1、功能说明接受广告图片，目前为一张2、接口调用说明2.1获取地址:8080/FamilyServiceSystem/BookDinnerQueryAction?operation=queryAdvertisePicture2.2http请求方式GET2.3数据返回格式JSON2.4传递参数参数名称是否必须类型示例描述facilitatorID是String000000平台广告，商家ID值固定为0000002.5成功返回结果serverResponse:Success,“advertisePicture” : “0f736a68b929b0955b319ebc41336.jpg”2.6返回结果解释参数名称类型描述备注advertisePictureString餐厅图片名称三、查询订单列表接口(DONE)1、功能说明根据指定的客户id查询订单2、接口调用说明2.1获取地址:8080/FamilyServiceSystem/BookDinnerQueryAction?operation=queryServiceOrderList2.2http请求方式GET2.3数据返回格式JSON2.4传递参数参数名称是否必须类型描述customerID是string提供客户idorderStatus否String提供查询条件不传该字段时查询所有状态的订单参数说明这个接口可以作为多种用途：搜索正在进行中的订单：customerID和orderStatus2.5成功返回结果serverResponse:Success,“data”：“orderNo” : “02135”“orderTime” : “11:00”,“orderStatus” : “评价完毕”,“paidAmount” : “30”2.6返回结果解释参数名