家教APP项目接口设计-用于记录

接口设计说明-程序子系统

模块接口清单

模块	说明
程序界面模块	主要包含获取主界面信息的接口
程序搜索模块	包含用于搜索的接口
程序数据模块	包含获取数据库中订单和教师的信息
替换教师模块	包含用于替换教师时的接口
发布订单模块	包含获取订单详细信息的接口
聊天模块	用于获取聊天对象的信息
分类模块	用于获取拥有的分类块

一、程序界面模块

接口	说明
Headpage.GetMainPhoto	获取轮播图的图片、界面
Headpage.GetSortTeacher	获取教师信息用以制作教师排行榜
Headpage.GetResultPhoto	获取家长结果中的图片
Headpage.GetResultText	获取家长结果中的文字

1.Headpage.GetMainPhoto 说明：

• 请求方式：GET
• 请求地址：/Headpage
• 请求参数：无

2.Headpage.GetSortTeacher 说明:

• 请求方式：GET
• 请求地址：/Headpage
• 请求参数：无

3.Headpage.GetResultPhoto 说明:

• 请求方式：GET
• 请求地址：/Headpage
• 请求参数：无

4.Headpage.GetResultText 说明:

• 请求方式：GET
• 请求地址：/Headpage
• 请求参数：无

二、程序搜索模块

接口	说明
Search.FindRec	用于搜索订单
Search.FindTeacher	用于搜索教师

1.Search.FindRec 说明:

• 请求方式：GET
• 请求地址：/Search
• 请求参数：无

2.Search.FindTeacher 说明:

• 请求方式：GET
• 请求地址：/Search
• 请求参数：无

三、程序数据库模块

接口	模块
Mess.Rec_All	获取数据库中订单的信息
Mess.Teacher_All	获取数据库中教师的信息

1.Mess.Rec_All 说明:

• 请求方式：GET
• 请求地址：/Mess
• 请求参数：无

2.MessTeacher_All 说明:

• 请求方式：GET
• 请求地址：/Mess
• 请求参数：无

四、替换教师模块

接口	模块
Turn.PaddRec	获取要更换的订单信息
Turn.PaddTeacher	获取订单绑定的教师

1.Turn.PaddRec 说明:

• 请求方式：POST
• 请求地址：/Turn
• 请求参数：无

2.Turn.PaddTeacher 说明:

• 请求方式：POST
• 请求地址：/Turn
• 请求参数：订单对象(无默认)

五、发布订单模块

接口	模块
Loading.GetCha	获取拥有的孩子的信息
Loading.DealRec	订单的详细信息

1.LoadingGetCha 说明:

• 请求方式：GET
• 请求地址：/Loading
• 请求参数：无

2.Loading.DealRec 说明:

• 请求方式：POST
• 请求地址：/Loading
• 请求参数：订单对象(无默认)

六、聊天模块

接口	模块
Chat.GetBlob	获取聊天的对象
Chat.AddBlob	增加聊天的对象

1.Chat.GetBlob 说明：

• 请求方式：GET
• 请求地址：/Chat
• 请求参数：无

2.Char.AddBlob 说明:

• 请求方式：POST
• 请求地址：/Chat
• 请求参数：聊天对象(无默认)

七、分类模块

接口	模块
MakeUp.GetMakeType	获取分类的块

1.MakeUp.GetMakeType 说明：

• 请求方式：POST
• 请求地址：/MakeUp
• 请求参数：无

用户子系统

模块接口清单

模块	说明
用户信息模块	包含对用户情况的操作接口
用户订单模块	包含对用户订单的操作的接口

一、用户信息模块

接口	说明
PlayerMes.ChaMes	获取与操作孩子的信息
PlayerMes.PlayerMes	获取和操作账号的信息

1.PlayerMes.ChaMes 说明:

• 请求方式：POST
• 请求地址：/PlayerMes
• 请求参数：孩子对象(默认为null)

二、用户订单模块

接口	说明
PlayerRec.RecMes	操作用户的订单

1.PlayerRec.RecMes 说明:

• 请求方式：POST
• 请求地址：/PlayerRec
• 请求参数：订单对象(默认为null)