《API需求设计文档范本》由会员分享，可在线阅读，更多相关《API需求设计文档范本（19页珍藏版）》请在金锄头文库上搜索。
1、 1 引言1.1 编写目的统一对外接口，方便使用接口的开发者根据文档进行开发和调试1.2 参考资料术语说明1.3 常量定义1.3.1 服务器地址请求基地址：，（请设置为）1.3.2 错误代码表示成功，失败代码。代码值说明无错误请求参数错误学生代码无效1.3.3 性别1.3.4 学校类型值说明小学五年制小学六年制初中三年制初中四年制高中1.3.5 用户角色2.1 接口说明此文档应包含所有手机客户端开发所需要调用的接口，但因文档水平以及设计周 期问题，难免会有缺漏.2.2 接口协议所有接口遵循协议，根据接口的不同需选择或的调用方式，返回数据均为格式2.3 请求2.4 请求参数所有请求参数均应使用然
2、后方式编码。使用方式调用时，应指定为“”。2.5 响应数据格式所有接口返回数据均为格式，如无特殊说明，均为如下数组形式: 错误信息,: : ,: 错误信息,: ,: 错误信息2.6 身份认证当用户登陆或注册成功时，服务器端返回客户端身份” 登录或注册成功后，访问身份认证的时，客户端需要传递用户身份，否则服务器 端返回错误代码。3 数据结构3.1 基本类型定义名称类型说明布尔型或，或位有符号整数位有符号整数位浮点数系统时间戳从格林威治时间年月日零时到现在的秒数。负值表示年往前的秒数。字符串3.2 基本信息结构3.2.1 图片信息用户信息3.3.1 老师用户信息3.33.3.2 学生用户信息字段变
3、量名类型说明3.4 圈子信息3.4.1 圈子基础信息字段变量名类型说明圈子标识圈子名称班主任任课教师成员信息数组3.4.2 圈子内容信息字段变量名类型说明内容标识内容标题内容图片发布者信息3.4.3 圈子评论信息字段变量名类型说明评论标识评论时间评论内容评论者信息发布时间4 接口4.1 班级圈请求基地址：，参数格式实例（以保存圈子用户为例） 实例（以获取圈子列表为例）4.1.1 获取圈子列表返回说明：多维数组，每个数组元素如下! ! !,! ! ! !,4.1.2 获取圈子主题:调用方式字段变量名类型说明可空圈子标识页数默认第一页每页数量默认条返回说明：多维数组，每个数组元素如下字段变量名说明
4、内容总数! H .! ! H .测试! H .!李四! !,4.1.3 获取主题评论返回说明：多维数组，每个数组元素如下字段变量名说明! ! H .! H .! ! H .测试! H .! ! H .! ! H .! ! H .李四,4.1.4 点赞返回说明! ! !4.1.5 在圈子发主题返回说明：多维数组，每个数组元素如下! ! !: 测试,4.1.6 给主题评论返回说明：多维数组，每个数组元素如下字段变量名说明! ! H .! ! H .测试! H .! ! ! H .! ! H .李四! H .,4.1.7 获取圈子用户返回说明：多维数组，每个数组元素如下字段变量名说明! ! ! !:! ! ! . ! ! !,! !4.1.8 添加圈子用户返回说明：多维数组，每个数组元素如下字段变量名说明主键创建时间是否删除代表未删除，代表已删除用户标识用户名称! ! ! H .! ! H .李四! H .,4.1.9 移除圈子用户返回说明：多维数组，每个数组元素如下字段变量名说明! ! !.9! !.! ! !.! ! !.李四! !.! !.,! !.
