文章目录
摘要
总功能:登录,注册,添加数据,修改数据,查询数据。
总的数据结构:
总体流程:物流管理员甲调用添加数据接口(添加数据,此时会生成包裹ID),运输到目的地后,转交给另一个管理员乙,此时乙调用修改数据接口,输入包裹ID,当前地点(Station)及甲的运输成本(Cost),就可将数据录入,以此类推。
查询功能:可以查询指定ID包裹所有的历史信息,也可以指定两地之间,得到两地间的运输成本及时间成本。
一、注册接口
1.1 请求地址(POST)
124.223.117.87/api/registry
1.2 请求数据(都是必选属性)
1.3 请求成功返回数据
前端需要显示在界面上的数据如下:
Name
(物流管理员姓名): 注册时所填的名字
目的:提示注册成功
1.4 请求出错返回数据
二、登录接口
2.1 请求地址(GET)
124.223.117.87/api/login
2.2 请求数据(都是必选)
2.3 请求成功返回
注意:返回的token需要保存,访问除注册登录外的其他接口时,需要携带在请求头元素"Authorization"中。
前端需要显示在界面上的数据如下:
Name
(物流管理员姓名)
目的:提示登录成功
2.4 请求失败返回
三、添加数据功能
3.1 请求地址(POST)
124.223.117.87/api/add/data
3.2 请求数据(都是必选)
请求头"Authorization"中携带token值:
请求体中携带数据:
State
(状态): 1代表运输中,0代表已送达
Station
(当前所在地): 包裹当前所在地
3.3 请求成功返回:
前端需要显示在界面上的数据如下:
ID
(订单编号): 自动生成,包裹唯一"身份证"。
State
(状态):1代表运输中,0代表已送达
Handler
(管理员):当前物流管理员。
HandlerPhone
(管理员电话): 管理员电话。
Station
(所在地):当前包裹所在地。
NowTime
(时间):该条数据录入的时间
目的:提示包裹添加成功
四、更新数据功能
4.1 请求地址(POST)
124.223.117.87/api/update/data
4.2 请求数据(都是必填)
ID
(编号):包裹编号
State
(状态): 1代表运输中,0代表已送达
Station
(所在地):当前所在地
Cost
(运输成本): 如从长沙到上海:运输成本为620
4.3 请求成功返回
需要显示到前端页面的数据有:
ID
(编号):包裹编号
State
…
Handler
…
HandlerPhone
…
Cost
…
CostTime
(时长): 从长沙运输到上海,总共花了多长时间,单位(秒)
LastStation
(上一站):长沙(上一站)-上海(当前站)
Station
…
NowTime
…
五、查询历史数据接口
5.1 请求地址(GET)
124.223.117.87/api/query/history
5.2 请求数据(都是必填)
ID
…
5.3 请求成功返回
按时间顺序,从上到下返回指定编号数据的所有历史信息。
需要显示到前端页面的数据有:
ID
…
State
…
Handler
…
HandlerPhone
…
Cost
…
CostTime
…
LastStation
…
Station
…
NowTime
…
六、富查询接口
6.1 请求地址(GET)
124.223.117.87/api/query/rich
6.2 请求数据
目的:查询出发点为长沙-到达点为上海的数据,得到花费的时间及金钱成本,得到最优路线。