http接口说明模板
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
http接口说明模板
一、查询菜品列表接口(DONE)
1、功能说明
接受提供的菜品
XXX画面XXX功能（比如人口查询画面-查询 | 人口查询画面-详细等）
2、接口调用说明
2.1获取地址
http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?op eration=queryServiceItem
2.2http请求方式
GET
2.3数据返回格式
JSON
2.4传递参数
类型示例描述
参数名称是否
必须
page 是String 1 获取第几个分页的菜
品，默认第一个分页
为1
pageSize 是String 5 每页显示多少个菜
品，默认为5 isFood 是String true 查询食物还是饮料，
查询食物为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返回结果解释
参数名称类型描述备注
page String 当前返回的
是第几页
id Int 菜品编号itemName String 菜品名字priceNow String 现价
pricePast String 原价servicePicture String 菜品图片
serviceStars String 菜品星级
二、查询广告接口（DONE）
1、功能说明
接受广告图片，目前为一张
2、接口调用说明
2.1获取地址
http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?op eration=queryAdvertisePicture
2.2http请求方式
GET
2.3数据返回格式
JSON
2.4传递参数
类型示例描述
参数名称是否
必须
facilitatorID是String 000000 平台广告，商家ID
值固定
为’000000’
2.5成功返回结果
{
"serverResponse":"Success",
“advertisePicture” : “0f736a68b929b0955b319ebc41336.jpg”
}
2.6返回结果解释
参数名称类型描述备注
advertisePicture String 餐厅图片名称
三、查询订单列表接口(DONE)
1、功能说明
根据指定的客户id查询订单
2、接口调用说明
2.1获取地址
http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?op eration=queryServiceOrderList
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返回结果解释
参数名称类型描述备注orderNo String 订单编号
orderTime String 订单时间orderStatus String 订单状态paidAmount String 订单金额