api接口设计说明书模板

《api接口设计说明书模板》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、WORD格式可编辑XXAPI接口设计说明书公司2016年11月25日专业技术知识共享WORD格式可编辑文档管理信息表主题XXapi接口设计说明书版本V0.1内容关键字参考文档创建时间创建人最新发布日期专业技术知识共享WORD格式可编辑文档变更记录表修改人修改时间修改内容创建专业技术知识共享WORD格式可编辑目录文档变更记录表3目录1引言1编写目的1背景1定义1参考资料1综述2统一的输入输出参数2必须登录才能访问的接口2错误返回码列表3用户接口4用户注册（user/signup）4用户登录（user/signin）5优惠券接口9我的优惠券（coupon/mycoup

2、on）9专业技术知识共享WORD格式可编辑引言编写目的{说明编写这份用户手册的目的，指出预期的读者。}背景{说明：a．这份用户手册所描述的软件系统的名称；b．该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的的计算站中心。}定义{列出本文件中用到的专门术语的定义和外文首字母组词的原词组。}参考资料{列出有用的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其它已发表的文件；c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来

3、源。}专业技术知识共享WORD格式可编辑综述统一的输入输出参数Request参数名类型是否必须描述languageStringYcn:中文，en:英文，th：泰文uidIntY用户ID.sidStringYSessonId（TOKEN）（不需要登录就能调用的接口、注册接口、登录接口，uid和sid两个参数不需要输入）Response参数名类型是否必须描述succeedIntY0：失败，1：成功error_codeIntN错误码error_descStringN错误消息必须登录才能访问的接口接口名称描述user/signout用户退出user/photoupload

4、照片上传user/changeprofile修改用户资料user/changepassword修改用户密码user/info获取用户信息专业技术知识共享WORD格式可编辑错误返回码列表error_codeerror_desc1授权过期500服务器内部错误600账号被锁定10001手机号码不能为空10002密码不能为空10003验证码不能为空10004平台类型不正确10005手机验证码不正确10006手机验证码已失效10007用户类型不正确10008用户名不能为空10009原密码不能为空10010新密码不能为空10011原密码不正确10012经度不能为空10013纬

5、度不能为空10014对象用户ID不能为空专业技术知识共享WORD格式可编辑用户接口用户注册（user/signup）接口user/signup描述用户注册验证Session方法GET/POSTRequest参数名类型是否必须描述mobileIntY注册手机号.verify_codeStringY手机验证码passwordStringY密码platformStringY平台类型（ios,android）Response参数名类型是否必须描述sidStringYSessonId（TOKEN）uidIntY用户IDExampleRequest{"mobile":"158

6、66667777","verify_code":"123456","password":"111111","platform":"android"}专业技术知识共享WORD格式可编辑Response1.错误情况{"succeed":0,"error_code":10006,"error_desc":"手机验证码已失效"}2.正常情况{"sid":"sess_573d27b370dc7","uid":"28","succeed":1}用户登录（user/signin）接口user/signin描述用户登录验证Session方法GET/POSTRequest参数名类型

7、是否必须描述mobileIntN注册手机号.(type=1时必须)usernameStringN用户名(type=2、3、4时必须)passwordStringN密码(type=1时必须)typeIntY用户类型专业技术知识共享WORD格式可编辑1：手机号2：QQ3：微信4：微博platformStringY平台类型（ios,android）Response参数名类型是否必须描述sidStringYSessonId（TOKEN）userArrayY用户信息idIntY用户IDuser_groupIntY用户角色1：普通用户2：专车车主nicknameStringY

8、昵称ema