福利社项目接口文档（版本1）
5星
- 浏览量: 0
- 大小:None
- 文件类型：DOCX
简介：
该项目的接口文档为福利社项目1。
本文档旨在概述福利社项目接口文档1中的五个关键接口：注冊、登入等基本功能；每个接口均负责特定操作并配有对应的访问地址。这些接口包括 head portrait upload（上传头像）、head portrait download（下载头像）以及 contact download（下载联系人）。一、注册接口的建立
* 接口功能描述：完成用户注册相关信息的录入至环信服务端及本地服务端。
* 接口关联的产品页面：用户登录后的个人资料详情页。
* 方法说明：采用GET方式向目标服务器发送数据包，请求路径为http:10.0.2.2:8080FuLiCenterServerServer，并包含一个名为request的参数。
* 请求参数信息：
+ 客户端请求类型：客户端请求类型为Request字段，必填且仅允许填写 register 值。
+ 用户的账号：userName，必填字段，数据类型为String，限定字符仅为字母、数字及下划线。
+ 昵称：nick，必填字段，数据类型为String，在中文环境下可包含汉字。
+ 密码：password，必填字段，数据类型为String，仅允许包含非空字符串。
* 应答参数信息：
+ 服务端返回的响应对象：返回的完整Response对象中包含状态码、详细说明和操作日志记录。
第二章 登陆界面设计
接口功能描述：该系统实现本地与远程系统的联合登录操作。关联的产品页面：登录界面。方法说明：采用HTTP GET协议进行数据请求传输，目标地址为http://10.0.2.2:8080FuLiCenterServerServer，并包含一个参数化的查询字符串，其中请求部分指定为login。请求参数信息：
+ 客户端的登录操作必须包括以下必填项：用户标识符、密码字段及不能为空的字符串类型信息。
+ 用户身份由用户名唯一标识，其名称限定为英文字母、数字以及下划线等字符范围。
+ 密码部分规定为非空字符串类型，并且仅允许包含字母、数字以及下划线的字符限定。响应参数信息：
+ 该接口返回的数据字段包含了完整用户资料对象，包括但不限于用户标识符、登录状态确认信息及个人属性记录等关键要素。
第三部分：图片上传接口
* 接口功能描述：客户端通过该接口向服务器提交头像上传请求。
* 接口关联的产品页面：与用户注册相关的详情页。
* 方法说明：采用POST方式向服务器发送数据，目标URL为$http://10.0.2.2:8080/FuLiCenterServer/upload-avatar?request=upload-avatar$。
* 请求参数信息：
+ 客户端提交类型：mandatory fields, 必填项, 类型为String, 值为upload_avatar。
+ 用户身份信息：userName，必填字段，数据类型为String。
+ 头像格式编码：avatarType，必要参数，字符串类型。
+ 文件上传内容：file，必需字段，字符数组类型的文件 upload-avatar。
* 应答参数信息：
+ 返回的数据结构：MessageBean, 包含返回状态码和详细信息的响应对象。四、获取个人形象接口
该接口负责响应客户端发送的获取用户头像数据的请求。
与之相关的具体产品页面是 MainActivity。
采用 GET 请求方式向 FuLiCenterServer 服务器发送 GET request指令，完整路径为 http://10.0.2.2:8080/FuLiCenterServer/DownloadAvatar。
客户端发送的 GET request指令中包含必要的 download_avatar 参数。
头像图片文件名字段命名为 avatar 且为必填属性。
响应中返回的 bitmap 格式的头像文件字段具有严格的 bitmap 类型要求。
第五节 下载联系人接口
* 接口功能描述：该接口通过客户端接收并处理用户好友请求的下载操作。
* 接口关联的产品页面：该接口与下列产品页面相关联：
- 界面名称1：友好提示框，显示用户的好友信息和操作指引；
- 界面名称2：详细操作说明文档。
* 方法说明：采用HTTP GET方法向目标服务器发送数据包，请求路径为$.../FuLiCenterServerServer?request=download_contacts。
* 请求参数信息：
+ 客户端请求类型：request（必填），类型为String，默认值为download_contacts；
+ 其他字段设置：根据具体需求进行配置。
该接口文档包含五个主要的用户操作功能模块，包括注册账户、登录系统以及处理个人资料等。每个功能模块对应特定的操作流程和唯一标识链接。开发人员可以通过选择适当的接口模块来执行所需的具体操作。
全部评论 (0)
