架构设计--用户端全http参数接口详细说明v1

 

 

1. 用户端全http参数接口详细说明v1.doc 1

2. change histor 1

3. 接口通用参数说明 1

4. 函数注册接口(规划中) 3

5. 用户权限模块 3

5.1. 用户注册接口(增加用户登陆数据) 3

5.2. 登陆接口(查询用户登陆权限数据接口) 4

6. 用户信息模块 5

6.1. 修改用户信息 5

7. 商品模块 5

7.1. 调用范例 5

7.2. 显示与查询商品列表接口 6

7.3. 显示商品详情(显示一条商品数据) 7

8. 订单模块接口 7

8.1. 添加订单数据 7

8.2. 查询订单数据(多条与单条) 9

 

1. 用户端全http参数接口详细说明v1.doc

2. change histor

p3t  v1 

 

作者:: 老哇的爪子 Attilax 艾龙,  EMAIL:1466519819@qq.com

转载请注明来源: http://blog.csdn.net/attilax

 

3.  接口通用参数说明

接口地址 http://localhost:8080/shopitfs/api_http.jsp

 

 

接口测试工具:: 浏览器直接测试。无需工具

 

调用范例 (注册用户)  

 

 http://localhost:8080/shopitfs/api_http.jsp?method=regNormalUser&$user_name=aaaa&$user_passwd=hhh&datatype=mall_users&op=add

 

 

 

通用http参数说明()

参数

说明

取值范例

参数值说明

op

操作动作

query,search,select,catch,poll 为查询操作

add/insert/create/reg新增,注册操作

 

modify,update,edit为更新修改编辑数据操作

del,delete,remove为删除移除数据操作

datatype

数据类型

xxxxx

要操作的数据对象

$field
(以美元符号开头的内部数据字段)

要新增或者更新的字段。只限于updateadd操作使用

$user_name=aaaa

 

condition

条件

name='aaa'

 

Name like like '%%'

 

支持>,<,=等操作符。 支持and,or 逻辑操作符连接多个条件

单引号作为字符串分界符

模糊查询为  like '%%' 格式

整个条件表达式语法与sql兼容 。

@field 

(以猴头符号开头的条件表达式字段)

表明条件字段。。只能表达简单and条件。如需其他复杂查询,使用condition字段。当此参数与conditon参数都有的时候,conditon参数优先使用

@user_name=aaaa

多个字段直接只能and 条件。如需其他复杂查询,使用condition字段

order

排序字段

Id 

 

id desc

a desc,b asc

数据的排序

支持asc,desc排序。

支持多字段排序,多字段用逗号分隔。语法与sql一致

 

 

 

 

page

翻页参数

1,10

1表示第一页,10表示pagesize

 

 

 

 

返回数据::基本全部为json格式

 

多个数据对象的连接复合查询(规划中)::

 

自定义函数的使用::

默认参数全部支持mysql5数据库的默认函数。。。如果要使用自定义函数,可以通过函数注册接口注册自定义函数

 

 

注:为了方便使用,许多功能尽可能的兼容sql语法,方便查询文档资料

 

4. 函数注册接口(规划中)

方法名: regFunction

参数::  函数体

 

5. 用户权限模块

5.1. 用户注册接口(增加用户登陆数据)

调用方法   regNormalUser

数据类型 :  mall_users

 

详细字段数据结构

 

数据字段

类型

说明

 

`user_id`

int(10)

用户id'

 

`user_email`

varchar(100)

用户email'

 

`user_name`

varchar(50)

用户名'

 

`user_passwd`

varchar(50)

用户密码'

 

`user_question`

varchar(255)

密码找回问题'

 

`user_answer`

varchar(255)

密码找回答案'

 

`user_ico`

varchar(255)

'用户头像'

 

`reg_time`

datetime

注册时间'

 

`last_login_time`

datetime

最后登陆时间'

 

`last_ip`

char(15)

最后登陆ip'

 

`email_check`

tinyint(1)

邮件确认'

 

`email_check_code`

varchar(255)

邮件确认码'

 

`forgot_check_code`

varchar(255)

密码找回码'

 

`rank_id`

int(10)

用户级别'

 

`locked`

tinyint(1)

用户锁定,1为锁定'

 

 

 

 

 

 

调用范例

http://localhost:8080/shopitfs/api_http.jsp?method=regNormalUser&$user_name=aaaa&$user_passwd=hhh&datatype=mall_users&op=add

 

调用范例(参数sql格式:略)

调用范例(xx格式:略)

 

返回数据:: 一般返回空,如果有返回,数据结构同注册。。如有异常,返回异常信息

 

 

5.2. 登陆接口(查询用户登陆权限数据接口)

 

调用方法   login4NormalUser

数据类型 :  同注册接口

 

详细字段数据结构::同注册接口

 

调用范例

http://localhost:8080/shopitfs/api_http.jsp?method=serachUserP3&@user_name=aaaa&@user_passwd=hhh&datatype=mall_users&op=query

 

返回数据:: 

如果有详细信息返回,登陆成功,数据结构同注册。。

如果无详细信息返回,说明密码错误

如有异常,返回异常。。

 

 

数据字段

类型

说明

 

`user_id`

int(10)

用户id'

 

`user_email`

varchar(100)

用户email'

 

`user_name`

varchar(50)

用户名'

 

`user_passwd`

varchar(50)

用户密码'

 

`user_question`

varchar(255)

密码找回问题'

 

`user_answer`

varchar(255)

密码找回答案'

 

`user_ico`

varchar(255)

'用户头像'

 

`reg_time`

datetime

注册时间'

 

`last_login_time`

datetime

最后登陆时间'

 

`last_ip`

char(15)

最后登陆ip'

 

`email_check`

tinyint(1)

邮件确认'

 

`email_check_code`

varchar(255)

邮件确认码'

 

`forgot_check_code`

varchar(255)

密码找回码'

 

`rank_id`

int(10)

用户级别'

 

`locked`

tinyint(1)

用户锁定,1为锁定'

 

 

 

 

 

 

 

 

6. 用户信息模块

6.1. 修改用户信息

调用方法    modifyUserinfo

数据类型 :  mall_user_info

 

详细字段数据结构::

 

`id`

int(10)

 

`user_id`

int(10)

用户id'

`user_truename`

varchar(255)

真实姓名'

`user_ico`

varchar(255)

用户头像'

`user_marry`

tinyint(1)

0保密,1未婚,2已婚'

`user_gender`

tinyint(1)

0保密,1男,2女'

`user_mobile`

varchar(20)

用户手机号'

`user_telphone`

varchar(20)

用户电话'

`user_country`

smallint(6)

国家'

`user_province`

smallint(6)

省份'

`user_city`

smallint(6)

城市'

`user_district`

smallint(6)

区'

`user_zipcode`

char(6)

用户邮编'

`user_address`

varchar(255)

用户地址'

`user_birthday`

date

用户生日'

`user_qq`

varchar(16)

用户qq'

`user_msn`

varchar(50)

用户msn'

`user_skype`

varchar(50)

用户skype'

 

 

调用范例参考以上模块

 

返回数据:: 如有异常,返回异常。。

 

 

 

 

7. 商品模块

7.1. 调用范例

 如上

 

7.2. 显示与查询商品列表接口

调用方法   searchGoods

 

操作数据类型::   mall_goods

 

数据字段

类型

说明

 

 

`goods_id`

int(10)

商品id

 

 

`shop_id`

int(10)

店铺id'

 

 

`goods_name`

varchar(255)

商品名称'

 

 

`cat_id`

int(10)

分类id'

 

 

`ucat_id`

int(10)

用户自定义分类id'

 

 

`brand_id`

int(10)

品牌id'

 

 

`type_id`

int(10)

属性类型id'

 

 

`goods_intro`

text

商品详情'

 

 

`goods_wholesale`

text

批发说明'

 

 

`goods_number`

int(5)

库存量'

 

 

`goods_price`

decimal(82)

商品价格'

 

 

`transport_price`

decimal(82)

运费'

 

 

`keyword`

varchar(255)

关键字'

 

 

`is_delete`

tinyint(1)

0为已删除'

 

 

`is_best`

tinyint(1)

1为精品'

 

 

`is_new`

tinyint(1)

1为新品'

 

 

`is_hot`

tinyint(1)

1为热销'

 

 

`is_promote`

tinyint(1)

1为特价'

 

 

`is_admin_promote`

tinyint(1)

 

 

 

`is_on_sale`

tinyint(1)

0为下架,1为上架'

 

 

`is_set_image`

tinyint(1)

是否已设置图片'

 

 

`goods_thumb`

varchar(255)

缩略图'

 

 

`pv`

int(10)

关注度'

 

 

`favpv`

int(10)

被收藏次数'

 

 

`sort_order`

tinyint(1)

排序'

 

 

`add_time`

datetime

添加时间'

 

 

`last_update_time`

datetime

最后修改时间'

 

 

`lock_flg`

tinyint(1)

锁定,1为锁定'

 

 

`is_transport_template`

tinyint(1)

是否启用邮费模版'

 

 

`transport_template_id`

int(11)

邮费模版id'

 

 

`transport_template_price`

float(50)

认默模板运费'

 

 

 

返回数据:: 

如果有数据,结构同上。。

如有异常,返回异常。。

 

7.3. 显示商品详情(显示一条商品数据)

调用方法   searchGoods

 

操作数据类型::   mall_goods

 

提交与返回的数据基本同搜索商品。。只需要设置条件类似 goods_id=1   就可。。。

8. 订单模块接口

8.1. 添加订单数据

调用方法    addOrderP29

数据类型 :  orderinfoVirt

 

范例

 

 

详细字段数据结构::

`order_id`

int(10)

订单id'

 

 

`payid`

varchar(20)

支付订单号'

 

 

`shop_id`

int(10)

店铺id'

 

 

`pay_id`

int(10)

支付方式id'

 

 

`pay_name`

varchar(255)

支会方式名称'

 

 

`user_id`

int(10)

用户id'

 

 

`transport_price`

decimal(6

运费'

 

 

`order_value`

float

订单应付金额'

 

 

`order_amount`

decimal(10

总订单价格'

 

 

`consignee`

varchar(50)

联系人'

 

 

`country`

smallint(6)

0'

COMMENT

国家'

`province`

smallint(6)

省份'

 

 

`city`

smallint(6)

城市'

 

 

`district`

smallint(6)

地区'

 

 

`address`

varchar(255)

'

COMMENT

详细地址'

`zipcode`

char(6)

邮政编码'

 

 

`telphone`

varchar(20)

电话'

 

 

`mobile`

varchar(20)

手机'

 

 

`email`

varchar(255)

邮箱'

 

 

`shipping_name`

varchar(50)

物流公司名称'

 

 

`shipping_no`

varchar(50)

物流发货单号'

 

 

`shipping_type`

varchar(50)

发货运输类型'

 

 

`message`

text

COMMENT

订单附言'

 

`order_time`

datetime

订单时间'

 

 

`pay_time`

datetime

支付时间'

 

 

`shipping_time`

datetime

发货时间'

 

 

`receive_time`

datetime

用户已接收时间'

 

 

`order_status`

tinyint(1)

订单状态:0已取消订单,1用户已下订单,2商家已确认订单,3用户验货'

 

 

`pay_status`

tinyint(1)

支付状态:0未支付,1已支付'

 

 

`transport_status`

tinyint(1)

发货状态:0未发货,1已发货'

 

 

`protect_status`

tinyint(1)

0'

COMMENT

维权状态

`trade_no`

varchar(50)

支付宝返回的,支付宝交易号'

 

 

`seller_reply`

tinyint(1)

买家是否回复:0未回复,1回复'

 

 

`buyer_reply`

tinyint(1)

卖家是否回复:0未回复,1回复'

 

 

`group_id`

int(10)

团购id'

 

 

`pay_message`

text

COMMENT

支付留言'

 

`complaint`

tinyint(1)

用户投诉'

 

 

`get_back_time`

datetime

申请退款时间'

 

 

`transport_type`

int(11)

运输类型1Ems

2平邮,3快递'

 

`order_actual`

decimal(10

COMMENT

实付金额'

 

 

返回数据:: 

如有异常,返回异常。。

 

 

8.2. 查询订单数据(多条与单条)

调用方法    queryOrderData

数据类型 :  order_goods_v

 

单条数据设置条件类似  order_id=1 就可

 

详细字段数据结构::

同上。商品有关的信息同商品结构表

 

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
中国移动无线城市集中运营服务平台系统项目 详细设计说明书 文档标识: 当前版本: 1.0 当前状态: 草稿 发布日期: 2012-8-28 发布  修改历史 日期 版本 作者 修改内容 评审号 变更控制号 2012-8-28 1.0 拓维 新建 目 录 1 总则 2 1.1 编写目的 2 1.2 读者对象 2 1.3 参考文档 2 1.4 术语与缩写 2 2 系统概述 2 2.1 模块结构 2 2.2 采用技术 3 3 模块设计 4 3.1 模块1 4 3.2 模块2…… 9 4 模块详细设计 9 4.1 模块1 9 4.2 模块2…… 12 1 总则 1.1 编写目的 明确任务和需求,使得软件开发人员知道软件开发流程,软件测试时更有条理 1.2 读者对象 描述该文档的阅读对象。 1.3 参考文档 描述该文档的参考文档。 1.4 术语与缩写 描述该文档的术语及解释。 2 系统概述 2.1 模块结构 描述软件系统的总体结构,可以使用结构图、层次分解图或包图来描述,并应说明系统结构划分的原则(例如,基于标准、协议所规定的体系结构,来自于分析模型的方案,或者基于原有体系结构的限制)。 示例: 2.2 采用技术 描述该系统所采用的技术。 示例: 数据ETL采用C++编程技术,经过FtpMain从外围系统抽取数据,Transfer_Main对数据进行清洗,load_data对清洗后的数据进行加载,完成ETL处理过程;前台流程配置界面采用JAVA编程技术,流程调度通过调度控件完成调度控制。 数据处理层(存储层、应用层、访问层)通过DB2存储过程技术实现对数据流的规则定义,通过调度程序完成数据流的流向控制。 最终展现,通过JAVA、JSP、HTML、GIS,视频监控等编程技术完成代码开发,并部署到WEB应用服务器(WebSphere等),主题采用BRIO工具结合WEB页面,地图技术,视频技术进行多维展现。 3 模块设计 按照需求进行模块分析和设计。 3.1 模块1 3.1.1 模块说明 描述该模块的功能,对该模块进行说明。 示例: 实体渠道:提供渠道发展用户分析、业务受理分析、渠道构成分析、资源分析、考核分析,监控和评估渠道的运营状况和管理能力。 如果采用面向对象的设计模式,则可以使用用例图等来说明这些设计类之间如何交互,实现本模块的典型功能。 示例: 用例主要包括购卡支付、购卡冲正、折扣查询、购卡历史记录查询等, 由于采用异步通信方式将支付、冲正分为请求和响应两个子用例。 用例说明: 购卡支付请求:该用例说明用户通过短消息、wap、web等通信接入手段购买卡系统提供的各种卡,以短信为例,用户通过短消息向系统提交购卡指令,系统查询卡类型及金额,如卡类型正确则生成订单消息,并向用户的银行帐号扣款的支付请求。 购卡支付响应:若支付请求返回正确响应,系统查询原订单和交易记录,返回相应的卡号和密码,以短消息形式通知用户;如出现超时或数据库操作异常,系统自动发起冲正请求 3.1.2 模块设计 描述模块设计。可以用流程图表示。 示例: 也可以用类图体现。 【利用Rose工具给出系统的主要类框图,描述系统的静态行为】 示例: 主要类说明 MpcpParseChainBean 包名 com.talkweb.card.buzi 类名 MpcpParseChainBean 父类名 ChainBean 责任描述  XML解析  短信指令解析  消息协议转换(MPCP2SpDeliverMsg->TradeInfo) 协同类 使用MPCP2SpDeliverMsg的unmarshal进行XML的解析; 使用TradeInfo作为内部交易协议; 使用DefaultDAO读取数据库中操作; 使用Log提供日志服务 属性 类型 描述 Logger Log 日志管理器 方法说明 方法名 process() 类型 protected Description 解析MPCP2SpDeliverMsg消息的XMLString转换为内部TradeInfo消息 Input InputMsg Output InputMsg Process  进行XML解析  调用MPCP2Trade()进行消息转换 方法名 MPCP2Trade() 类型 private Description MPCP2SpDeliverMsg消息转换TradeInfo Input MPCP2SpDeliverMsg(MPCP短消息) Output TradeInfo(本地交易报文) Process  调用parseCommand()解析短消息内容  将MPCP短消息转换为本地交易报文 方法名 parseCommand() 类型 private Description 解析短信内容为功能码 Input String(短信内容) Output Int(功能码) BUY_CARD= 100; QUERY_MONEY= 110; QUERY_FACE= 111; QUERY_HIS = 120; REPORT= 130; HELP = 140; UNKNOW_COMMAND= 0; Process 根据短信息内容产生功能码 3.1.3 数据结构 描述该模块对应的数据模型。 3.2 模块2…… 同3.1章节。 4 模块详细设计 4.1 模块1 4.1.1 功能点1 4.1.1.1 功能说明 对该功能点进行描述(比如:新增,修改,删除,查询等功能); 或者对该功能点的具体信息进行描述。 示例: 渠道发展用户日分析: 通过时间、地域、品牌、地理位置类型、排他性等角度分析各类渠道每日新增及离网用户的情况,实现对渠道的整体分析和监控。 支持切片、钻取,旋转等分析操作,以图表形式展现, 能够打印图表,并且能将图,表分别以图片格式,excel格式导出. 4.1.1.2 数据设计 描述后台的数据设计(存储过程)。 A示例(功能点): 存 储 过 程 名: CHLDW.ETL2_CUB_COUNTY_ADD_USER_DAY 分 析 类 型: 主题 结 果 表: CHLWI.CUB_CHL_ADD_USER_DAY 运 行 周 期: 日 调 用 方 式: CALL CHLDW.ETL2_CUB_COUNTY_ADD_USER_DAY (YYYYMMDD,0,999,?); 前 驱: 版 本: 1.0 设 计 人: 需 求 分 析 章 节: 1.5.1 需 求 编 码: WCMN000000001M 变 更 情 况: 统计步骤: 1) 开号用户数:取基础层的用户信息表(CHLODS.ODS_USR_INFO)与基本信息表(chlwi.t_channel_basicinfo)用渠道标志(CHANNEL_ID)关联,根据状态标志STS_ID=18,统计开号用户数量. 2) 销号用户数: 取基础层的用户信息表(CHLODS.ODS_USR_INFO)与基本信息表(chlwi.t_channel_basicinfo)用渠道标志(CHANNEL_ID)关联,根据状态标志STS_ID = 20,统计开号用户数量. 3) 预销号用户数:取基础层的用户信息表(CHLODS.ODS_USR_INFO)与基本信息表(chlwi.t_channel_basicinfo)用渠道标志(CHANNEL_ID)关联,根据状态标志STS_ID IN (19,21),统计开号用户数量. 或采用Sequence图来表示。 示例: 4.1.1.3 界面设计 示例: 主界面: 新增修改界面: 4.1.1.4 接口设计 描述接口。 4.1.2 功能点2….. 同4.1.1章节。 4.2 模块2…… 同4.1章节。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值