应用服务接口设计文档.docx
文档编号版本号KYB-SD-I3V2.0应用服务接口设计文档20XX年09月11日修订记录文档版本制定人发布日期修改说明V1.0接口整理V2.0规范文档格式1引言1编写目的11.1 术语与缩略词1参考资料12接口列表13 基础 Base13.1 货品列表1货品查询23.2 货品添加3货品修改33.3 货品删除3 111引言1引言编写目的本文档旨在说明详细接口输入输出定义，前后端开发人员直接参考。1.1 术语与缩略词序号术语名称术语说明1.2 参考资料序号文档名称作者/功能组版本1前后端交互公共说明文档VLOV1.02接口列表接口列表编号接口名称Path所属模块调用者 货主端1配送端1 管理端1收件人 端1服务器KYB-SD-I-3006货品列表/goods/type/list基础(base )货主端1配送端1 管理端KYB-SD-I-3007货品查询/goods/type/query基础（base ）管理端KYB-SD-I-3008货品添加/goods/type/add基础(base)管理端KYB-SD-I-3009货品修改/goods/type/modify基础(base)管理端KYB-SD-I-3010货品删除/goods/type/delete基础(base )管理端3基础Base3.1货品列表名称货品列表路径地址/goods/type/list调用者货主端|配送端|管理端3基础Base请求方式Get, Post请求公共参数令牌参数备注Request参数说明参数名称类型例如描述日不 Atzl1必填page_sizenumber30分页大小，默认30否page_numbernumber1分页序号，从1开始否Response参数说明返回数据data说明类型：array ,详细结构如下：参数名称类型例如描述idnumber1编号namestring玻璃货品名称sequencenumber1序号create_timedate2019-09-09 11:20:30创立时间update_timedate2019-09-09 11:20:30更新时间3.2货品查询名称货品查询路径地址/goods/type/query调用者管理端请求方式Get, Post请求公共参数令牌参数备注Request参数说明参数名称类型例如描述日不 At 11必填idnumber1编号是Response参数说明返回数据data说明类型：object,详细结构如下：参数名称类型例如描述idnumber1编号namestring玻璃货品名称sequencenumber1序号create_timedate2019-09-09 11:20:30创立时间update_timedate2019-09-09 11:20:30更新时间3基础Base货品添加名称货品添加路径地址/goods/type/add调用者管理端请求方式Get, Post请求公共参数令牌参数备注Request参数说明参数名称类型例如描述甲7K At J必填namestring玻璃货品名称是sequencenumber1序号是Response参数说明返回数据data说明为空货品修改名称货品修改路径地址/goods/type/modify调用者管理端请求方式Get, Post请求公共参数令牌参数备注Request参数说明参数名称类型例如描述旦不 必填idnumber1编号是namestring玻璃货品名称否sequencenumber1序号否Response参数说明返回数据data说明为空货品删除名称货品删除路径地址/goods/type/delete调用者管理端请求方式Get, Post3基石出Base请求公共参数令牌参数备注Request参数说明参数名称类型例如描述日不 At. 14必填idnumber1编号是Response参数说明返回数据data说明为空
