API接口设计说明书（2020年十二月整理）.docVIP

PAGE PAGE 1 XXAPI 接口设计说明书 公司 2016年11月25日  文档管理信息表 主题 XX api接口设计说明书 版本 V0.1 内容 关键字 参考文档 创建时间 创建人 最新发布日期 文档变更记录表 修改人 修改时间 修改内容 创建 【机密】上海莫辩信息科技有限公司 PAGE 2 目 录 文档变更记录表 3 目 录 1 引言 1 编写目的 1 背景 1 定义 1 参考资料 1 综述 2 统一的输入输出参数 2 必须登录才能访问的接口 2 错误返回码列表 3 用户接口 4 用户注册（user/signup） 4 用户登录（user/signin） 5 优惠券接口 9 我的优惠券（coupon/mycoupon） 9 PAGE 2 引言 编写目的 {说明编写这份用户手册的目的，指出预期的读者。} 背景 {说明： a． 这份用户手册所描述的软件系统的名称； b． 该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的的计算站中心。} 定义 {列出本文件中用到的专门术语的定义和外文首字母组词的原词组。} 参考资料 {列出有用的参考资料，如： a． 本项目的经核准的计划任务书或合同、上级机关的批文； b． 属于本项目的其它已发表的文件； c． 本文件中各处引用的文件、资料、包括所要用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期