API接口设计说明书.doc

API接口设计说明书 本文档旨在详细介绍XX API接口设计说明书的内容，涵盖了接口设计的目的、背景、定义、参考资料、综述、统一的输入输出参数、错误返回码列表、用户接口等多方面的内容。 编写目的： 本文档的目的是为了提供一个详细的接口设计说明书，指导开发人员、测试人员和其他相关人员正确地使用XX API接口。 背景： XX API接口设计说明书是XX公司2016年11月25日发布的文档，旨在提供一个统一的接口设计标准，确保XX API接口的正确使用和开发。 定义： 在本文档中，我们定义了一些专门术语的解释和缩略语，例如API、uid、sid、TOKEN等，以便于读者更好地理解接口设计的内容。 参考资料： 在本文档中，我们列出了有用的参考资料，包括本项目的经核准的计划任务书、合同、上级机关的批文、属于本项目的其它已发表的文件、本文件中各处引用的文件、资料、包括所要用到的软件开发标准等。 综述： XX API接口设计说明书的主要内容包括统一的输入输出参数、错误返回码列表、用户接口等多方面的内容。统一的输入输出参数部分定义了Request和Response参数的名称、类型、是否必须、描述等信息，例如language、uid、sid等。错误返回码列表部分定义了一些常见的错误码和错误描述，例如授权过期、服务器内部错误、账号被锁定等。用户接口部分定义了用户注册、登录、照片上传、修改用户资料、修改用户密码、获取用户信息等多种接口的描述、Request参数、Response参数等信息。 统一的输入输出参数： Request参数名 类型 是否必须 描述 language String Y 语言类型，例如中文、英文、泰文 uid Int Y 用户ID sid String Y SessoionId（TOKEN） Response参数名 类型 是否必须 描述 succeed Int Y 0：失败，1：成功 error_code Int N 错误码 error_desc String N 错误消息 错误返回码列表： error_code error_desc 1 授权过期 500 服务器内部错误 600 账号被锁定 10001 手机号码不能为空 10002 密码不能为空 10003 验证码不能为空 10004 平台类型不正确 10005 手机验证码不正确 10006 手机验证码已失效 10007 用户类型不正确 10008 用户名不能为空 10009 原密码不能为空 10010 新密码不能为空 10011 原密码不正确 10012 经度不能为空 10013 纬度不能为空 10014 对象用户ID不能为空 用户接口： 用户注册（user/signup）： 描述：用户注册验证Session方法 Request参数名 类型 是否必须 描述 mobile Int Y 注册手机号 verify_code String Y 手机验证码 password String Y 密码 Response参数名 类型 是否必须 描述 succeed Int Y 0：失败，1：成功 error_code Int N 错误码 error_desc String N 错误消息 ...