PDF《前言 1.1》

4 Demo 获取用户的科目列表 URL http://member.dongao.com/api/userSubject.html? accessToken=07e4a4e018c3f906bb0acf6538f3f3c9&

userId=18175724 GET 请求参数 参数 描述 返回参数 字段 描述 成功 前言

5 接口规范 作者 时间 修订内容 备注 韩伟 2016-05-03 创建 无1. 接口分为get和post,其中登录注册or提交表单类的使用post接口,其他使用 get接口 2. 所有response中的字段都是string类型 3. 每个接口要有version字段 例如:http://examapi.test.com/V1/index/homePage.html 中的V1 4. post请求,所有的字段都放在body中5. 如果response中某个字段没有数据,应该返回这个字段,且内容为 例如: result :{ code :

1 , msg : }, 6. response中有两个主要字段:result,body 7. common字段: deviceType:设备类型 Iphone:0 Andorid Phone:1 Ipad:2 Android pad:3 uniqueId:设备唯一标识 version:版本号 app:app包名 appName:app名字例如: da-jxjy-app timeStamp:时间戳 random:随机数 mobileAccessToken:后台登录和注册时返回的token sign:一个签名值 签名规则:接口所有参数,按照key值的字母顺序 拼成如: userName=1234&

password=1234串,然后加salt 取md5 salt: 9538b01d8d3e4c1ab3ba450adb3bea6a 8. 接口文档采用gitBook书写,我们会先写一下demo 9. 如下是以前写的demo,可以作为参考 http://docs.test.com/projectdocs/daapi/examapi/_book/examapiv12/index2.html 接口规范

6 接口规范

7 后台调用组件化规则 作者 时间 修订内容 备注 韩伟 2016-05-03 创建 无 韩伟 2016-05-06 修改 增加transformType 为了满足通过后台指令,打开App组件的指定功能,制定此规则. 例如: 1. 首页中的每一个item,都是一条后台指令,可以打开App的某一模块的某个功 能. 2. 首页banner也是如此. 3. 学吧,学吧详情也是如此. 规则如下: 每条指令为一个json,json为一个字典(dic/map)中的内容包括: scheme:后台定义的应用名称 target:组件模块名称 action:组件功能名称 transformType:启动界面的方式和类型

0 push方式

1 present方式 params:对应参数,应该是个字典 后台调用组件化规则

8 First Chapter GitBook allows you to organize your book into chapters, each chapter is stored in a separate file like this one. 01_注册登录

9 0101_登录 作者 时间 修订内容 备注 丰宗伟/邓汉森 2016-04-28 创建 无 赵威 2016-5-9 23:09:20 更新 无 赵威 2016-5-17 修改 无 赵威 2016-6-6 修改 测试url 赵威 2016-6-13 添加 code URL http:\/\/192.168.0.173:8080\/app\/api\/v1\/mobile\/appLogin 更换域名后URL: http://api.dongao.com/app/api/v1/mobile/appLogin POST 请求参数 参数名 备注 类型 userName 用户名(手机号) String password MD5加密 String -- 下面两个参数common有-- uniqueId 机器标示 String .. version 版本号 string deviceType 表示代表苹果、安卓手机、apad、 ipad String(可选) 见common 0101_登录

10 返回code表: code msg

1000 登录成功

1001 参数为空

1005 对象不存在

1007 密码错误 返回字段名称 字段名称 描述 accessToken token userId 用户ID id 用户ID username 用户名 fullName 全名 sex 性别 avatar 头像 age 年龄 正确 0101_登录

11 result :{ code :

1000 , msg : 成功 }, body :{ accessToken : 7ebbc89735568731cf7a77b0ec0e7ab2 , userId :18175724, user :{ id :18175724, username : zhichenga , createdAt : 创建时间 } } 错误 e.g result : { code :