其他随笔

一份完整齐全的技术方案文档-案例

2022年-[归一计划三期-用户中心三期第二阶段]技术方案部门:基础架构部时间:2022.02.251、背景描述技术方案的背景由于历史原因,旧服务存在很多代码不规范、冗余度高、扩展性差等问题,为了解决此类问题,以及将功能进行清晰的模块化划分,为以后用户中心隔离打好基础,需要将旧服务用户相关的功能或接口进行重构,下沉至新用户中心旧服务用户相关旧接口:接口地址接口描述调用方3个月内请求量2周内请求量开

2022年-[归一计划三期-用户中心三期第二阶段]技术方案


部门:基础架构部


时间:2022.02.25


1、背景

描述技术方案的背景

由于历史原因,旧服务存在很多代码不规范、冗余度高、扩展性差等问题,为了解决此类问题,以及将功能进行清晰的模块化划分,为以后用户中心隔离打好基础,需要将旧服务用户相关的功能或接口进行重构,下沉至新用户中心


旧服务用户相关旧接口:

接口地址 接口描述 调用方 3个月内请求量 2周内请求量 开发阶段顺序

checkOrganizationState 查询店铺异常 C端(小程序)

addAllGoodsAdditionPrice 一键加价(全局) B端(小程序、APP)

/weiXinUser/addWechatUserGroup 记录用户所属用户群 C端(小程序)

/user-tag/get-tags.action 用户标签 C端(小程序、APP)

接口地址 接口描述 调用方 3个月内请求量 2周内请求量 开发阶段顺序

/weiXinAgreement/grantUserAgreement 用户协议同意 C端(小程序) 31416916 9686584

/weiXinAgreement/getUserAgreementInfo 查询用户协议是否同意 C端(小程序) 1562389 863210

/weiXinUser/initWeiXinUserInfo 微信用户授权初始化 C端(小程序) 390172 125239

/weiXinUser/updateAllIsShowStoreGoodsGroup 全局设置店铺是否显示分组 B端、C端(小程序、APP) 7463 2352

/weiXinUser/checkRealIDCard 身份证实名认证检测 B端、C端(小程序) 13875102 605118

2、业务流程图

用图描述此技术方案的实现处理过程


蓝湖

检查店铺是否异常接口

一键加价

记录用户所属微信群

用户标签

用户同意协议接口

用户初始化

设置全局的是否展示分组

身份证实名认证检测

3、领域模型

列出需求对象、关键属性和对象之间的关系

4、数据库设计

4.1 表关系图(对应:领域模型)

ER图

2 表设计

表的数据字典设计

无


4.3 SQL语句设计

SQL语句设计,例如索引技术、分区字段使用等。如没有,则写无

索引技术

BTREE


分区字段使用说明

无


5、技术要点

5.1 核心内容

简要体现后续工作的主要内容和难易程度,目的在于让文档阅读人员快速抓住重点。

5.2 系统架构图

整个架构最终的输出模型状态。如果是部分重构或新增部分,可以用不同颜色区分新旧部分

5.3 相关UML图

有多种状态需要说明的,则附加,例如泳道图等。如没有,则写无

以下新序列图按方案一编写,方案二相对于方案一少了新服务的调用,暂不单独出图


5.3.3 查询店铺是否异常

(旧)


不支持在 Docs 外粘贴 block


(新)


不支持在 Docs 外粘贴 block


5.3.4 一键加价

(旧)


不支持在 Docs 外粘贴 block


(新)


5.3.5 记录用户所属微信群

(旧)

cd992992009183cec2865622f904522d.png

2c4ace1c08ef72b1b4de74fb1522092b.png

6、接口设计

用户中心swagger

(为了规范参数名字的命名,下面的红色参数为改动的参数,字段意思不变,只是修改了参数名字,表示店主id)

入口(小程序、APP)


接口名称


旧接口 (plus)


旧接口入参


新接口入参


新接口 (weeget-bullet-user-rest)


小程序


查询店铺是否异常


/weiXinUser/checkOrganizationState


{


"organizationId" : 135700927


}


{


"organizationId" : 135700927


}


/user/organization/checkOrganizationState


小程序


一键加价


/weiXinUser/addAllGoodsAdditionPrice


{


"organizationId":135700927,


"additionPrice":123836168,


"groupId" : 111


}


{


"organizationId":135700927,


"additionPrice":123836168,


"groupId" : 111


}


/user/organization/addAllAdditionPrice


小程序


记录用户所属微信群


/weiXinUser/addWechatUserGroup


{


"organizationId":135700927,


"userId":123836168,


"encry

原创不易,完成人机校验,阅读全文

相关推荐