API接口设计说明书范文.docx

XXAPI 接口设计说明书 公司 2016 年11 月25日 文档管理信息表 主题 XX api 接口设计说明书 版本 内容 关键字 参考文档 创建时间 创建人 最新发布日期 文档变更记录表 修改人 修改时间 修改内容 创建 目 录 文档变更记录表 .......................................................... 目 录 . .................................................................. 引言 . ................................................................... 编写目的 ..................................................... 背景 ......................................................... 定义 ......................................................... 参考资料 ..................................................... 综述 . ................................................................... 统一的输入输出参数 ........................................... 必须登录才能访问的接口 ....................................... 错误返回码列表 ............................................... 用户接口 . ............................................................... 用户注册（ user/signup ） ...................................... 用户登录（ user/signin ） ...................................... 优惠券接口 .............................................................. 我的优惠券（ coupon/mycoupon ） ................................ 引言 编写目的 { 说明编写这份用户手册的目的，指出预期的读者。 } 背景 { 说明： a． 这份用户手册所描述的软件系统的名称； b． 该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的的计算站中 心。 } 定义 { 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 } 参考资料 { 列出有用的参考资料，如： a． 本项目的经核准的计划任务书或合同、上级机关的批文； b． 属于本项目的其它已发表的文件； c． 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、 发表日期和出版单位，说明能够得到这些文件资料 的来源。 } 综述 统一的输入输出参数 Request language String Y cn: 中文， en: 英文， th ：泰文 uid Int Y 用户 ID. sid String Y SessonId （TOKEN） （不需要登录就能调用的接口、注册接口、登录接口， uid 和 sid 两个参数不需要输入） Response succeed Int Y 0：失败， 1：成功 error_code Int N 错误码 error_desc String N 错误消息 必须登录才能访问的接口 接口名称 描述 user/signout 用户退出 user/photoupload 照片上传 user/changeprofile 修改用户资料 user/changepassword 修改用户密码 user/info 获取用户信息 错误返回码列表 error_code error_desc 1 授权过期 500 服务器内部错误 600 账号被锁定 10001 手机号码不能为空 10002 密码不能为空 10003 验证码不能为空 10004 平台类型不正确 10005 手机验证码不正确 10006 手机验证码已失效 10007 用户类型不正确 10008 用户名不能为空 10009 原密码不能为空 10010 新密码不能为空 10011 原密码不