软件工程论文

准考证号：

本科生毕业论文（设计）

广东电信综合平台接入与接入信息管理系统分析与设

计究

学 院： 江西科技学院 专 业： 软件工程

班 级： 学生姓名： 欧阳占柱 指导老师： 樊冰 完成日期： 2016年4月9日

本科论文原创性申明

本人郑重申明：所呈交的论文（设计）是本人在指导老师的指导下独立进行研究，所取得的研究成果。除了文中特别加以标注引用的内容外，本论文（设计）不包含任何其他个人或集体已经发表或撰写的成果作品。对本文的研究做出重要贡献的个人和集体，均已在文中以明确方式表明。本人完全意识到本申明的法律后果由本人承担。

学位论文作者签名（手写）：欧阳占柱 签字日期：2016年 4 月 9 日

本科论文版权使用授权书

本学位论文作者完全了解学校有关保留、使用学位论文的规定，同意学校保留并向国家有关部门或机构送交论文的复印件和电子版，允许论文被查阅和借阅。本人授权江西科技学院可以将本论文的全部或部分内容编入有关数据库进行检索，可以采用影印、缩印或扫描等复制手段保存和汇编本学位论文。

学位论文作者签名（手写）：欧阳占柱 指导老师签名（手写）：

签字日期：2016 年 4 月 11 日 签字日期： 年 月 日

江西科技学院本科生毕业论文（设计）

摘要

当前中国电信能力开放平台，对于合作方的管理，包括合作方信息管理，应用信息管理，合作方(开发者)对于综合平台系统API的查阅等操作，均需要通过线下手工操作数据库或管理人员线下管理完成，但随着综合平台飞速发展，这种运作模式已经不能满足业务上对于数据和时效性的要求，同时人力成本也大大提升，因此需要一个管理门户供合作方管理和分析接入的应用，并对合作方的接入，应用的接入进行统一的，自动化信息管理。针对以上问题，基于J2EE，SOA等成熟WEB开发技术开发了能力开放平台开发者门户系统，该系统采用UML进行建模设计，根据研发的系统撰写本文。

文章首先对系统的整体设计订立目标，对系统的业务，功能，数据提出相应的数据目标；而后，对系统进行总体设计与模块划分为7大模块，包括注册天翼帐号、登录天翼帐号、开发者信息管理，应用管理，API文档，帮助文档，下载文档管理等，并通过类图等描述模块的设计，例如E-R图等对数据库进行设计。

在当今国内外移动互联网发展的趋势下，能力整合和平台化成为各企业，

尤其是大型企业发展的重点。而对于能力开放平台来说，百度，淘宝，腾讯等多家企业，均有其自有的合作方管理平台，用以统一化，流程化管理每一个合作方，简便快速的接入方式，也更加巩固了其在业内的领先地位，而本文在对各平台对于合作方管理平台的理解上，整合和设计合作方管理平台的基本功能设计和定义，一方面为电信合作方平台提供设计基础，另一方面为业务统一化提供系统流程上支撑。

关键词：中国电信能力开放平台开发者门户、开发者、门户、UML建模、数据建模

I

江西科技学院本科生毕业论文（设计）

Abstract

The current China Telecom capability open platform, the management of developer information，application information, and look up information in system API were needed to finish manual by the platform staff. With the rapid development of the China Telecom Integrated Platform, this mode has been unable to meet the business requirements for data and timeliness. At the same time, the human cost is greatly improved. So it is necessary to have a portal for developer partner management, application analysis, the access of the developer and application and information automation management. In view of the above problems, we develop the Developer Portal of Capability Open Platform in J2EE and SOA framework, build model with UML, and finally write the paper.

Firstly, the paper puts forward the goals of all the overall design, including data goals of business, function and data; Then, the system is divided into 7 modules, including register and login Tianyi account, developer information management, application management, API, help and download document management, and through the class diagram to describe the module design, and use E-R diagram to design the database.

With the rapid development of mobile internet, capability integration and platform has become the enterprises, especially large enterprises development emphases. For capability open platform, Baidu, Alibaba, Tencent have their own platform to manage their partner and the simple access way consolidate its leading position in the industry. This paper integrate and design the basic function and definition of the capability open platform, which is based on the understanding of other platform. On the one hand to provide design basis for the platform, on the other hand support system for business process..

Keywords: China telecom integrated platform; Developer; Portal; UML; Data

Modeling

II

江西科技学院本科生毕业论文（设计）

目 录

第1章 引言 ····································································· 1

1.1 项目背景与问题概述 ·························································· 4

1.1.1 项目背景 ······························································· 4 1.1.2 问题概述 ······························································· 4 1.2 研究的意义和重要性 ·························································· 5

1.2.1 研究的意义 ···························································· 5 1.2.2 研究的重要性 ························································· 5

1.3 研究的主要内容 ································································ 6

第2章 需求分析 ······························································· 7

2.1 业务需求 ········································································· 7

2.1.1 业务描述 ································································ 7 2.1.2 主要业务流程 ·························································· 7 2.2 功能需求 ········································································· 13

2.2.1 业务功能 ································································ 13

第3章 系统设计 ········································································ 38

3.1 总体设计 ········································································· 38 3.2 功能模块设计 ··································································· 38

3.2.1 门户注册 ································································ 38

第4章 结论

参考文献 ····················································································· 45 致 谢 ························································································ 46

III

江西科技学院本科生毕业论文（设计）

第1章 引言

1.1 项目背景与问题概述

1.1.1 项目背景

20世纪90年代初以来，随着改革开放的深入和国力的增强，面对地区发展 中国电信能力开放平台（也称综合平台），建基于智能管道，以天翼帐号为建设核心，融合中国电信通信能力，定位能力，支付能力，整合国内外知名移动互联网企业的优势资源，为3亿移动互联网用户打造新型生态圈。随着综合平台建设工作推进，综合平台自身及整合的能力逐步完善。目前综合平台拥有的能力包括帐号注册认证、支付、定位、流量币交易等能力，能为合作伙伴提供标准化的接口、SDK等能力输出。

同时，随着综合平台对接产品逐步增加，综合平台拥有的用户数快速增长。截至到2014年6月，中国电信综合平台接入的产品数超过50个，主要包括189邮箱、天翼云、天翼视讯、爱音乐、爱动漫、号百、易信等，累计注册用户超过2.4亿，月活跃用户数达6000万，日活跃用户数超400万。预期到2014年底，将有更多的产品接入到综合平台，为综合平台带来更多的用户数据。如何将综合平台的能力及用户资源提供给合作伙伴，为综合平台及合作伙伴创造更大的价值，成为目前急需解决的问题。

1.1.2 问题概述

中国电信能力开放平台(综合平台)作为电信能力的汇聚点，拥有丰富的开放能力，包括通信、支付、定位、内容、应用、流量交易等。如何使得开发者能有效统一获得中国电信的各种能力，实现能力价值最大化，将成为下一阶段能力开放平台重点研发的目标。

目前基于能力开放平台对外开放的各种能力，均需通过线下联络产品经理，再进行能力权限分配，技术对接联调等反复工序，每接入一款应用，均需要大概1-2周的工作日和产品经理，技术开发等至少3到5人负责支撑。这一方面，接入的效率因为人工流程的阻碍而大大降低，另一方面人工管理可能存在遗漏，疏忽等各种问题。因此需要一个面向开发者，自动化的平台，让开发者自助接入从而使得效率最大化，流程规范化。

目前其他一些电信相关的能力开放平台，由于自身的局限性(如只负责某一方面的能力)，无法全面涵盖各个方面的能力需求，开发者需要从各个平台分别

4

江西科技学院本科生毕业论文（设计）

注册以便接入能力，使用上非常麻烦。

1.2 研究的意义和重要性

1.2.1 研究的意义

中国电信能力开放平台开发者门户，目的在于打造开发者与平台能力之间的桥梁，使得开发者能在一个统一的，自助的，高效的门户，接入中国电信开放平台相关能力，实现能力价值最大化。

同时，门户实现开发者及其创建的应用信息统一化管理，基于Oauth2国际通用标准和业务权限拦截，进一步对业务管理透明化，可视化，操作智能化。这样做一方面能统一业务逻辑，对近似业务进行统一化，规范化处理，使得每个流程节点均有迹可循，有理可依；另一方面，减轻业务对接人员或客服负担，自动化流程也使得在业务人员和客服人员身上投入成本减少。

再者，使用系统业务流程代替人工流程，极大减少业务出错几率，同时扩大了使用范围，使得业务规模增长不再受限于人工处理能力；另一方面，也极大提高合作商的满意度。

最后，给予规范化的业务流程，为后续业务发展提供可扩展延伸，后续可陆续接入各种扩展能力，打造一个基于能力汇聚的地基平台。

1.2.2 研究的重要性

中国电信能力开放平台开发者门户的研究，重点推进接入自动化流程，使得开发者能通过网页即可自动注册，并使用中国电信相应的业务能力能，如通讯录能力，流量交易能力，账号认证能力等。

通过中国电信相关业务能力的开放，一方面让更多开发者、合作商使用电信的能力对其业务进行开发或扩展，使得原本只有在营业厅的业务能在开发者开发的应用中体现，通过渠道分成，流量经营，资源交换整合等方式，为双方带来多层次，多方向的价值。

另一方面，通过合作方门户开放，增速接入规模，扩大能力面向群体，突破原本因为人力资源导致的瓶颈，进一步扩大中国电信在行业的影响力，稳步提升在互联网市场上的份额从而增强中国电信品牌的号召力。

1.3 研究的主要内容

5

江西科技学院本科生毕业论文（设计）

中国电信能力开放平台开发者门户的研究，刻画了开发者、合作商如果通过门户申请接入注册并使用中国电信相关能力，及里面所包含的业务流程，论文的主要内容有：

1、对B/S体系结构、J2EE技术开发框架，以及数据库及相关技术的研究，对业务进行细化分析，分析需求(包括功能和非功能需求)，并以用例图的形式展现，阐述了开发者信息管理，应用信息管理，文档管理等功能需求；通过活动图阐述开发者信息申请、审核，应用申请、审核等关键流程的描述。

2、根据系统整体体系结构的设计要求，提出了结构框架，技术架构和相应的应用。如功能序列图、结构图，描述了系统的功能设计；使用E-R图表示的数据库设计的概念，给出了数据库的表结构。

3、在最后进行了总结和展望。

6

江西科技学院本科生毕业论文（设计）

第2章 需求分析

2.1 业务需求

2.1.1 业务描述

（一）、系统能够实现对开发者账号的注册，开发者信息的注册，编辑；管理员能对开发者进行审核，修改状态，编辑等一系列操作

（二）、系统能够实现开发者对其应用的管理，包括应用的创建，编辑，统计信息；管理员能够对开发者提交的应用进行审核，自动分配接入参数，修改状态，编辑等。

（三）、系统能够实现开发者对API文档信息，帮助文档信息，以及所需要用到的辅助开发包(SDK工具包)进行下载；管理员能够对API文档信息，帮助文档信息，下载文档信息及文件进行管理和审核。

（四）、系统响应速度在合理范围，不容易宕机，不存在等待过长情况。 2.1.2 主要业务流程 （一）用户登录

用户登录流程主要描述用户登录的步骤，其中，用户的账户密码信息是

需要提交到账号系统进行校验。用户登录流程如下。

图2-1 用户登录活动图

7

江西科技学院本科生毕业论文（设计）

（二）用户注册活动图

用户注册流程主要描述用户注册天翼账号流程，其中，用户的账户密码

信息是需要提交到账号系统进行校验和注册。用户注册流程如下。

图2-2 用户注册活动图

8

江西科技学院本科生毕业论文（设计）

（三）开发者接入引导活动图

有别于账号注册，开发者注册是基于用户已经是天翼账号，并且已经登

录的情况下，申请注册开发者身份，并完善开发者相关信息，其中，信息需要提交到本系统的后台管理部分，由客服管理员核对开发者资料并给予审核反馈信息，只有审核通过成为开发者，才能确定为开发者身份并拥有权限创建自己的应用，并继续后续的申请流程。当开发者完成开发者身份注册识别后，就可以根据自己的需求，创建自己的应用。所谓应用，就是通过申请一个与开发者所需系统相匹配的管理对象，并在开发者控制台对其进行管理。应用在开发者提交信息后，需要经过客服管理员在后台审核并给予审核意见，审核通过后，系统将会给予每个应用一组唯一匹配的应用key和应用秘钥，开发者即可凭此信息调用综合平台的相关能力开放接口(通过Oauth2协议)。而另一方面，综合平台又可以对此进行相应的管理。

图2-3 开发者接入引导活动图

9

江西科技学院本科生毕业论文（设计）

（四）开发者信息修改活动图

当开发者注册完成开发者信息后，若对信息需要进行修改，则可在开发者信息管理修改其相关信息，信息需要提交到本系统的后台管理部分，由客服管理员核对开发者资料并给予审核反馈信息，只有审核通过成为开发者，才能确定为开发者身份并拥有权限创建自己的应用，并继续后续的申请流程。开发者修改流程如下。

10

江西科技学院本科生毕业论文（设计）

图2-4 开发者接入修改活动图

（五）应用接入修改活动图

当开发者完成开发者身份注册识别后，并创建了属于自己的应用后，可

根据需求修改应用信息。应用信息在修改后，同样需要管理员审核，并且在审核过程中，应用的相关权限会被暂时收回。应用接入修改流程如下。

图2-5 应用接入修改活动图

11

江西科技学院本科生毕业论文（设计）

（六）文档审核活动图

除了开发者信息，应用信息的审核和接入之外，开发者需要根据一定的

技术规范，才能接入综合平台的相关能力。而参考的重要依旧就是文档，而文档又分成三个方面。一是API文档，它帮助开发者快速掌握请求的方式，参数的个数，返回的信息是什么等相关技术细节；二是帮助文档，其中就包括使用手册，以及调试遇到问题，应该如何解决，以及客服、产品经理联系方式等，为开发者提供支撑和保障；三是开发包的文档以及下载，其中包含了一些帮助开发者快速开发的开发包以及指引文件，旨在让开发者快速完成对接开发。三者共同之处，都是要对分类和文档进行编辑以及审核，其具体流程如下。

图2-6 文档审核活动图

12

江西科技学院本科生毕业论文（设计）

2.2 功能需求

功能需求分析，着重于描述系统与操作者，系统与系统之间的关联关系，并且刻画了各模块的划分及其应该具备的功能点。

2.2.1 业务功能

从业务需求分析后，系统总共分为两大模块，包括前端接入和后台管理两大块，包含12个功能模块，其中又根据功能细分成相应的用例，如下系统总用例

图示：图2-7 系统总体用例图

2.2.1.1 门户注册

图2-8 用户注册用例图

13

江西科技学院本科生毕业论文（设计）

表2-1用户注册用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 门户注册 UseCase01 描述了用户注册天翼账号的整个过程 开发者 1 无 跳转至对应页面或弹框显示错误反馈信息 1.开发者在首页点击用户注册 2.填写注册信息 3.点击提交，信息进行校验，校验通过返回成功 4.若校验失败，则提醒用户哪里需要重新填写及要注意的事项 5.保存用户信息 6.记录登录信息 可选流程 无 14

江西科技学院本科生毕业论文（设计）

2.2.1.2 门户登录

图2-9 用户登录用例图

表2-2用户登录用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 门户登录 UseCase02 描述了用户登录天翼账号的整个过程 开发者 1 无 跳转至对应页面或弹框显示错误反馈信息 1.开发者在首页点击用户登录 2.填写登录信息 3.点击提交，信息进行校验，校验通过返回成功 4.若校验失败，则提醒用户哪里需要重新填写及要注意的事项 5.记录用户登录信息 可选流程 1.用户三次登录失败后，需要增加验证码输入校验 15

江西科技学院本科生毕业论文（设计）

2.用户五次输入密码错误失败后，账号冻结10分钟

2.2.1.3 查看API文档

图2-10 查看API文档用例图

表2-3查看API文档用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 查看API文档 UseCase03 描述了用户查看API文档的过程 开发者 1 文档需是审核通过状态 跳转至对应页面或弹框显示错误反馈信息 1.开发者点击首页”API文档”链接 2.展开API分类页面，选择分类并点击 3.展示具体文档文章 可选流程

16

无 江西科技学院本科生毕业论文（设计）

2.2.1.4 查看帮助文档

图2-11 查看帮助文档用例图

表2-4查看帮助文档用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 查看帮助文档 UseCase04 描述了用户查看帮助文档的过程 开发者 1 文档需是审核通过状态 跳转至对应页面或弹框显示错误反馈信息 1.开发者点击首页”帮助文档”链接 2.展开帮助分类页面，选择分类并点击 3.展示具体文档文章 可选流程 无 17

江西科技学院本科生毕业论文（设计）

18

江西科技学院本科生毕业论文（设计）

2.2.1.5 下载SDK开发包

图2-12 下载SDK开发包用例图

表2-5下载SDK开发包用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 下载SDK开发包 UseCase05 描述了用户查看下载文档及下载SDK开发包的过程 开发者 1 文档需是审核通过状态 跳转至对应页面或弹框显示错误反馈信息 1.开发者点击首页”下载”链接 2.展开下载分类页面，选择分类并点击 3.展示具体文档文章 4.选择需要用到的sdk开发包，点击下载，把文件通过浏览器下载回来 可选流程

无 19

江西科技学院本科生毕业论文（设计）

2.2.1.6 开发者信息管理

图2-13 开发者信息管理用例图

表2-6开发者信息注册用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 开发者信息注册 UseCase06 描述了开发者注册信息的过程 开发者 1 用户已登录并未注册过开发者 跳转至对应页面或弹框显示错误反馈信息 1.用户登录后，点击”控制台”链接 2.根据自身情况填写申请表格 3.上传证件照片(个人：身份证，企业：营业执照) 4.提交信息并等待审核 可选流程

无 20

江西科技学院本科生毕业论文（设计） 表2-7开发者信息编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 开发者信息编辑 UseCase07 描述了开发者编辑注册信息的过程 开发者 1 用户已登录并已经注册过开发者 跳转至对应页面或弹框显示错误反馈信息 1.用户登录后，点击”控制台”链接 2.点击我的信息，然后点击”修改”按钮 3.根据自身情况修改表单内容 4.修改证件照片并上传(如需要) 5.提交并等待信息审核 可选流程

无 2.2.1.7 应用信息管理

图2-14 应用信息管理用例图

21

江西科技学院本科生毕业论文（设计）

表2-8应用信息创建用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 应用信息创建 UseCase08 描述了开发者注册应用信息的过程 开发者 1 用户已登录且提交开发者信息审核通过 跳转至对应页面或弹框显示错误反馈信息 1.用户登录后，点击”控制台”链接 2.点击”添加应用” 3.根据自身情况填写申请表格 4.提交信息并等待审核 可选流程

表2-9应用信息编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 应用信息编辑 UseCase09 描述了开发者编辑应用信息的过程 开发者 1 用户已登录且提交开发者信息审核通过 跳转至对应页面或弹框显示错误反馈信息 1.用户登录后，点击”控制台”链接 2.点击应用列表中需要修改的应用图标 3.点击”应用信息”tab页 4.根据自身情况修改表单内容 5.提交并等待信息审核 22

无 江西科技学院本科生毕业论文（设计）

可选流程

表2-10查看应用统计信息用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 查看应用统计信息 UseCase10 描述了开发者查看应用统计信息的过程 开发者 1 用户已登录且提交开发者信息审核通过 跳转至对应页面或弹框显示错误反馈信息 1.用户登录后，点击”控制台”链接 2.点击应用列表中需要修改的应用图标 3.点击”应用统计”tab页 4.根据不同条件查询应用统计信息 可选流程

无 无 2.2.1.8 开发者信息维护管理

图2-15 开发者信息维护管理用例图

23

江西科技学院本科生毕业论文（设计）

表2-11开发者信息审核用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 开发者信息审核 UseCase11 描述了客服管理员审核开发者信息的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”开发者信息管理” 2.点击某个开发者的详情信息 3.保存并修改审核意见 4.确认信息后点击”通过”，”不通过”等状态并提交 5.审核信息通过邮件和短信发送通知开发者 可选流程

表2-12开发者状态变更用例描述

24

不通过需要填写不通过原因描述 江西科技学院本科生毕业论文（设计）

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 开发者状态变更 UseCase12 描述了客服管理员变更开发者状态的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”开发者信息管理” 2.点击某个开发者的详情信息 3.勾选开发者需要变更的状态并提交 4.状态变更信息通过邮件和短信发送通知开发者 可选流程 表2-13开发者信息编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 开发者信息编辑 UseCase13 描述了客服管理员变更开发者信息的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”开发者信息管理” 2.点击某个开发者的详情信息 3.修改开发者信息并提交 4.信息变更通过邮件和短信发送通知开发者 可选流程

2.2.1.9 应用信息维护管理

25

江西科技学院本科生毕业论文（设计） 图2-16 应用信息维护管理用例图

表2-14开发者信息审核用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 应用信息审核 UseCase14 描述了客服管理员审核应用信息的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”应用信息管理” 2.点击某个应用的详情信息 3.保存并修改审核意见 4.确认信息后点击”通过”，”不通过”等状态并提交 5.审核信息通过邮件和短信发送通知开发者 6.若通过审核，后台自动给应用分配appKey和appSecret，用于Oauth2授权接入 26

江西科技学院本科生毕业论文（设计）

可选流程 表2-15应用状态变更用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 应用状态变更 UseCase15 描述了客服管理员变更应用状态的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”应用信息管理” 2.点击某个应用的详情信息 3.勾选应用需要变更的状态并提交 4.状态变更信息通过邮件和短信发送通知开发者 可选流程

表2-16应用信息变更用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 应用信息变更 UseCase16 描述了客服管理员变更应用信息的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”应用信息管理” 2.点击某个应用的详情信息 3.修改应用信息并提交 4.变更信息通过邮件和短信发送通知开发者 27

江西科技学院本科生毕业论文（设计）

可选流程

2.2.1.10 API文档管理

图2-17 API文档管理用例图

表2-17文档目录编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 文档目录编辑 UseCase17 描述了客服管理员新建和编辑API文档目录的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”API文档目录管理” 2.点击新建目录 3.输入目录名称，排序号等信息，并提交 4.点击已经存在的目录 5.点击编辑，并修改信息，提交修改 6.勾选需要删除分类，点击删除，删除该分类 28

江西科技学院本科生毕业论文（设计）

可选流程

表2-18文档编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 文档编辑 UseCase18 描述了客服管理员新建和编辑API文档的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”API文档管理” 2.点击新建文档 3.输入文档名称，文档内容等信息，并提交 4.点击已经存在的文档 5.点击编辑，并修改信息，提交修改 6.勾选需要删除文档，点击删除，删除该文档 可选流程

表2-19文档审核用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程

文档审核 UseCase19 描述了客服管理员审核API文档的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”API文档管理” 29 江西科技学院本科生毕业论文（设计） 2.点击指定文档，打开详情 3.输入审核状态(通过,不通过) 4.输入审核意见，保存提交 可选流程

审核不通过需要反馈审核意见 2.2.1.11 帮助文档管理

图2-18 帮助文档管理用例图

表2-20文档目录编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 文档目录编辑 UseCase20 描述了客服管理员新建和编辑帮助文档目录的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”帮助文档目录管理” 2.点击新建目录 3.输入目录名称，排序号等信息，并提交 4.点击已经存在的目录 5.点击编辑，并修改信息，提交修改 30

江西科技学院本科生毕业论文（设计） 6.勾选需要删除分类，点击删除，删除该分类 可选流程 表2-21文档编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 文档编辑 UseCase21 描述了客服管理员新建和编辑API文档的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”帮助文档管理” 2.点击新建文档 3.输入文档名称，文档内容等信息，并提交 4.点击已经存在的文档 5.点击编辑，并修改信息，提交修改 6.勾选需要删除文档，点击删除，删除该文档 可选流程 表2-22文档审核用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程

文档审核 UseCase22 描述了客服管理员审核帮助文档的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”帮助文档管理” 31

江西科技学院本科生毕业论文（设计） 2.点击指定文档，打开详情 3.输入审核状态(通过,不通过) 4.输入审核意见，保存提交 可选流程

审核不通过需要反馈审核意见 2.2.1.12 下载管理

图2-19 下载管理用例图

表2-23下载分类编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 下载分类编辑 UseCase23 描述了客服管理员新建和编辑下载文档目录的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”下载文档目录管理” 2.点击新建目录 3.输入目录名称，排序号等信息，并提交 4.点击已经存在的目录 32

江西科技学院本科生毕业论文（设计） 5.点击编辑，并修改信息，提交修改 6.勾选需要删除分类，点击删除，删除该分类 可选流程

表2-24下载文档编辑用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 下载文档编辑 UseCase24 描述了客服管理员新建和编辑下载文档的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”下载文档管理” 2.点击新建文档 3.输入文档名称，文档内容等信息，并提交 4.点击已经存在的文档 5.点击编辑，并修改信息，提交修改 6.勾选需要删除文档，点击删除，删除该文档 可选流程

表2-25下载文件上传用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 下载文件上传 UseCase25 描述了客服管理员上传文档附件的过程 客服管理员 1 管理员已登录后台 33

江西科技学院本科生毕业论文（设计）

后置条件 基本流程 跳转至对应页面或弹框显示错误反馈信息 1.点击”下载文档附件管理” 2.点击需要上传的文档 3.选择并提交文件 4.点击提交确认上传 可选流程

表2-26文档审核用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 下载文档审核 UseCase26 描述了客服管理员审核帮助文档的过程 客服管理员 1 管理员已登录后台 跳转至对应页面或弹框显示错误反馈信息 1.点击”下载文档管理” 2.点击指定文档，打开详情 3.输入审核状态(通过,不通过) 4.输入审核意见，保存提交 可选流程

审核不通过需要反馈审核意见 2.2.1.13 开发者接入引导

图2-20 下载管理用例图

34

江西科技学院本科生毕业论文（设计）

表2-27开发者信息注册引导用例描述

用例名称 序号 用例描述 开发者信息注册引导 UseCase27 描述了开发者根据系统配置步骤，打开开发者信息管理相应的页面以进行开发者信息注册 活动者 优先级 前置条件 后置条件 基本流程 开发者 1 用户已登录 跳转至对配置好的流程页面 1.开发者点击申请接入按钮 2.系统根据开发者实际情况判断开发者信息申请到哪一个步骤(例如填写基本信息步骤、上传证件步骤) 3.跳转至相应的功能链接 可选流程

表2-28应用信息注册引导用例描述

用例名称

无 应用信息注册引导 35

江西科技学院本科生毕业论文（设计）

序号 用例描述 UseCase28 描述了开发者根据系统配置步骤，打开应用信息管理相应的页面以进行应用信息创建 活动者 优先级 前置条件 后置条件 基本流程 开发者 1 用户已登录，并且通过开发者信息审核 跳转至对配置好的流程页面 1.开发者点击申请接入按钮 2.判断用户是否已经已经具备审核通过的开发者资质(开发者信息审核通过) 3.系统根据开发者实际情况判断开发者应用信息申请到哪一个步骤(例如填写基本信息步骤、附件信息填写步骤) 3.跳转至相应的功能链接 可选流程

表2-29接入调试用例描述

用例名称 序号 用例描述 活动者 优先级 前置条件 后置条件 基本流程 接入调试 UseCase29 描述了开发者打开测试调试页进行接口调试 开发者 1 用户已登录并成功申请通过至少一个应用 跳转至测试调试页面 1.开发者点击申请测试按钮 2.系统判断用户是否合乎标准(如找到通过的开发者信息和应用信息) 3.打开测试调试页面并把应用id和秘钥预先填写在页面上且该信息不可编辑 无 36

江西科技学院本科生毕业论文（设计）

4.用户可使用这一套id和秘钥，调用综合平台API进行测试() 可选流程 无

37

江西科技学院本科生毕业论文（设计）

第3章 系统设计

在需求分析完成后，在软件代码撰写之前，软件工程项目和其他项目一样，必须经过分析设计阶段。设计是对软件需求的进一步细化，同时，为软件开发提供详实的模型基础，指导软件开发人员合理的开发，使得开发的产品与目标需求一致。

3.1 总体设计

图3-1 系统总包图

系统一共分为两个子系统，门户子系统和管理平台子系统。其中，门户子系统又分为门户注册、门户登录、查看API、查看帮助、下载SDK、开发者信息管理、应用信息管理、开发者接入引导共8个模块。管理平台子系统又分为开发者信息维护、应用信息维护、API文档管理、帮助文档管理、下载管理共5个模块。

3.2 功能模块设计

3.2.1 门户注册

3.2.1.1 功能结构式设计

图3-2 门户注册包图

38

本文来源：https://www.bwwdw.com/article/1vx7.html