http接口说明模板.docxVIP

http接口说明模板 查询菜品列表接口（DONE） 1、 功能说明 接受提供的菜品 XXX画面XXX功能（比如人口查询画面-查询I人口查询画面-详细 等） 2、 接口调用说明 2.1获取地址 :8080/FamilyServiceSystem/BookDi nn erQueryActio n?op erati on=queryServiceltem 2.2http 请求方式 GET 2.3数据返回格式 JSON 2.4传递参数 参数名称 是否 必须 类型 示例 描述 page 是 Stri ng 1 获取第几个分页的菜 品，默认第一个分页 为1 pageSize 是 Stri ng 5 每页显示多少个菜 品，默认为5 isFood 是 Stri ng true 查询食物还是饮料， 查询食物为true 饮料为false 饮料和食物为空 2.5成功返回结果 [ “ serverResp onse ” : ” Success”， “totalRecords ” : ” 52”， TOC \o 1-5 \h \z page : 10 , pageSize : 5 , “ data ”： { “ id ”： “ 123”， “itemName : “皇堡”， “priceNow”： “io”， “ pricePast ” : “ 12” , “servicePicture ”： ” s9ii8668.jpg “ serviceStars ” : “ 3” }， priceNowpricePast “servicePicture ”： ” s9ii8668.jpg “ serviceStars ” : “ 3” } ] 2.6返回结果解释 参数名称 类型 描述 备注 page Stri ng 当前返回的 是第几页 id Int 菜品编号 itemName Stri ng 菜品名字 priceNow Stri ng |现价 pricePast Stri ng 原价 servicePicture Stri ng 菜品图片 serviceStars Stri ng 菜品星级 】、查询广告接口（ DONE 1、 功能说明 接受广告图片，目前为一张 2、 接口调用说明 2.1获取地址 :8080/FamilyServiceSystem/BookDi nn erQueryActio n?op erati on=queryAdvertisePicture 2.2http 请求方式 GET 2.3数据返回格式 JSON 2.4传递参数 参数名称 是否 必须 类型 示例 描述 facilitatorlD 是 Stri ng 000000 平台广告，商家ID 值 固 定 为’000000 2.5成功返回结果 { serverResp on se:Success, “advertisePicture ” : “ 0f736a68b929b0955b319ebc41336.jpg } 2.6返回结果解释 参数名称 类型 描述 备注 advertisePicture Stri ng 餐厅图片名称 三、查询订单列表接口 （DONE） 1、 功能说明 根据指定的客户id查询订单 2、 接口调用说明 2.1获取地址 :8080/FamilyServiceSystem/BookDi nn erQueryActio n?op erati on=queryServiceOrderList 2.2http 请求方式 GET 2.3数据返回格式 JSON 2.4传递参数 参数名称 是否必须 类型 描述 customerID 是 stri ng 提供客户id orderStatus 否 Stri ng 提供查询条件 不传该字段时查询所有状态的订］ 单 参数说明 这个接口可以作为多种用途： 搜索正在进行中的订单：customerlD 和 orderStatus 2.5成功返回结果 { serverResp on se:Success, “ data” :[ { “orderNo ” ： “02135” “orderTime ” : “ 11:00”， “ orderStatus ” :“评价完毕”， “ paidAm ount ” “30” } 2.6返回结果解释 参数名称 类型 描述 备注 orderNo Stri ng 订单编号 orderTime Stri ng 订单时间 orderStatus Stri ng 订单状态 paidAm ount Stri ng 订单金额