接口

消息接口

消息的发送与获取

功能用于发送和获取消息
接口地址 /restful/message/{id}
请求方式
- get: 获取消息
  - 返回值: Message 实体
- post: 发送消息
  - 返回值: 在服务端数据库存储的该消息的 id, 用于客户端缓存消息

用户接口

登录

功能用于用户登录
接口地址 /restful/user/login
请求方式
- post: 登录
  - 请求参数 account, password
  - 返回值: Person 类

搜索用户

功能使用已知的帐号信息查询某用户
接口地址 /restful/user/search/{account}
请求方式
- get: 搜索用户, 目前不支持模糊搜索
  - 返回值 json 格式 Person

注册

功能用于注册用户
接口地址 /restful/user
请求方式
- post: 注册
  - 请求body: Person
  - 返回值: 服务端的id

修改用户信息

功能修改用户信息
接口地址 /restful/user/{account}
请求方式
- post: 修改用户信息
  - 请求 body: Person
  - 返回值：状态

获取用户信息

功能获取用户信息
接口地址
- /restful/user/{id}
  - 请求方式 get: 获取用户信息
  - 返回值: Person 类（不含密码、好友列表等私密信息)
- /restful/user/account/{account}
  - 请求方式 get: 获取用户信息
  - 返回值: Person 类(不含密码，好友例诶包等私密信息)

好友接口

获取好友列表

功能用于获取好友列表
接口地址 /restful/user/friend/{acount}
请求方式
- get: 获取用户好友
  - 返回值该用户所有好友的 id

添加好友

功能为账户添加好友
接口地址 /restful/user/friend/{account}
请求方式
- post: 添加好友
  - 返回值: Result 状态

班级接口

创建班级

功能创建班级
接口地址 /restful/class
请求方式
- post: 创建班级
  - 返回值: Result 状态

获取班级信息

功能获取班级信息
接口地址 /restful/class/{id}

搜索班级

功能搜索班级
接口地址 /restful/class/find/{classNum}
请求方式
- get: 通过班级 classNum 搜索班级
- 返回值: Class

注意

客户端、服务端统一使用 Spring, 因此解析都使用 Jackson, 无需统一格式，直接使用时间戳即可