需求文档的生成方法、装置、存储介质及电子设备
技术领域
本申请涉及计算机领域,尤其涉及一种需求文档的生成方法、装置、存储介质及电子设备。
背景技术
随着计算机技术的发展,越来越多的企业部署信息化系统,信息化系统一般包含多个子系统,为了实现各个子系统之间的通信,会根据需求文档开发子系统的集成接口,其他子系统调用集成接口来与本系统进行通信。目前的需求文档是在需求分析阶段编写的,集成接口的代码在后续的开发阶段和测试阶段中可能会发生更新,然而代码的更新难以及时准确的更新到需求文档中。
发明内容
本申请实施例提供了的需求文档的生成方法、装置、存储介质及电子设备,可以解决相关技术中需求文档更新不及时的问题。所述技术方案如下:
第一方面,本申请实施例提供了一种需求文档的生成方法,所述方法包括:
通过显示单元显示检索界面;
获取用户通过所述检索界面输入的检索条件,以及根据所述检索条件在接口代码集合中进行检索得到检索结果;
响应于用户的选择指令从所述检索结果中选择一个接口代码;
基于预设的生成规则生成所述接口代码的需求文档。
第二方面,本申请实施例提供了一种需求文档的生成装置,所述装置包括:
显示单元,用于显示检索界面;
查询单元,用于获取用户通过所述检索界面输入的检索条件,以及根据所述检索条件在接口代码集合中进行检索得到检索结果;
选择单元,用于响应于用户的选择指令从所述检索结果中选择一个接口代码;
生成单元,用于基于预设的生成规则生成所述接口代码的需求文档。
第三方面,本申请实施例提供一种计算机存储介质,所述计算机存储介质存储有多条指令,所述指令适于由处理器加载并执行上述的方法步骤。
第四方面,本申请实施例提供一种电子设备,可包括:处理器和存储器;其中,所述存储器存储有计算机程序,所述计算机程序适于由所述处理器加载并执行上述的方法步骤。
本申请一些实施例提供的技术方案带来的有益效果至少包括:
在生成接口代码的需求文档时,基于检索界面进行检索得到包含一个或多个接口代码的检索结果,基于用户的选择指令从检索结果中选择一个接口代码,然后根据预设的生成规则生成该接口代码的需求文档,解决了相关技术中接口代码和需求文档不匹配的问题,在现有根据需求文档进行接口开发的基础上,基于规范的接口开发框架,实现反向根据接口代码自动生成需求文档的功能。
附图说明
为了更清楚地说明本申请实施例或现有技术中的技术方案,下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍,显而易见地,下面描述中的附图仅仅是本申请的一些实施例,对于本领域普通技术人员来讲,在不付出创造性劳动的前提下,还可以根据这些附图获得其他的附图。
图1是本申请实施例提供的需求文档的生成方法的流程示意图;
图2是本申请实施例提供的用户界面示意图;
图3是本申请实施例提供的需求文档中包括的组织信息集成的示意图;
图4是本申请提供的一种需求文档的生成装置的结构示意图;
图5是本申请提供的一种电子设备的结构示意图。
具体实施方式
为使本申请的目的、技术方案和优点更加清楚,下面将结合附图对本申请实施例方式作进一步地详细描述。
下面将结合附图1-附图3,对本申请实施例提供的需求文档的生成方法进行详细介绍。
请参见图2,为本申请实施例提供了一种需求文档的生成方法的流程示意图。如图2所示,本申请实施例的所述方法可以包括以下步骤:
S101、通过显示单元显示检索界面。
其中,检索界面为电子设备的显示单元上显示的用于人机交互的图形界面,检索界面上包括多个控件,控件的类型包括输入框、按钮、滑动条等,用户可以通过输入设备对控件进行交互操作,交互操作的类型包括但不限于:鼠标交互操作、键盘交互操作或触控交互操作等。
S102、获取用户通过检索界面输入的检索条件,以及根据检索条件在接口代码集合中进行检索得到检索结果。
其中,检索界面包括输入框的控件,输入框用于输入检索条件,检索条件的数量为多个时,相应的输入框的数量也为多个。本申请的检索条件可以为:区域、第三方系统名称和集成应用名称,区域表示接口代码的适用范围,例如包括:全国、河南或河北等;第三方系统名称表示与本系统的集成接口对接的第三方系统的名称,集成应用名称表示接口接口的项目名称。
例如:参见图2所示的检索界面的示意图,检索界面包括检索输入框和检索结果显示框,在检索输入框中输入关键字“nw-nc”后,在检索结果显示框中显示检索到的接口代码,用户在检索到的接口代码中选择一个接口代码,如图2所示,选择的接口代码的属性为:项目名称“nw-nc-gldx7324”,版本号“1.0.0”,项目描述、框架版本号、项目类型、构建时间、系统分组、业务分组和备注等信息。
其中,接口代码集合中包括多个接口代码,接口代码集合可以为一个关系型数据库部署在需求文档生成系统中。电子设备向接口代码集合发送查询指令,查询指令携带查询条件,接口代码集合响应于查询指令返回检索结果,以及在显示单元显示检索结果,检索结果包括接口代码的编号以及接口代码的项目名称、项目描述、第三方系统名称、版本号、框架版本号、开发人员和需求人员等。项目名称表示接口代码所在的项目的名称、项目描述表示项目的主要信息的描述,第三方系统名称表示本系统的集成接口对接的第三方系统的名称,版本号表示接口代码的版本的序号,框架版本号表示开发接口代码的软件工具箱的版本;开发人员表示开发接口代码的人员的姓名,需求人员表示需求方的姓名。
S103、响应于用户的选择指令从检索结果中选择一个接口代码。
其中,选择指令是用户通过交互操作触发生成的,交互操作的类型可以书鼠标交互操作、键盘交互操作或触控交互操作,电子设备基于用户的选择指令从检索结果中选择一个接口代码。
S104、基于预设的生成规则生成接口代码的需求文档。
其中,预设的生成规则是电子设备预先定义的规则,例如:电子设备从需求文档生成系统中获取接口代码的属性信息,以及解析接口代码的逻辑关系,根据逻辑关系生成需求文档,以及存储需求文档。
例如:参见图2所示的用户界面,用户界面包括导出控件,检测到导出控件上的触发操作时,将检索到的接口代码生成需求文档,然后将生成的需求文档导出到指定的路径中。
在一个或多个可能的实施例中,所述需求文档包括文档名称;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
获取所述接口代码的区域、项目名称、第三方系统名称和本系统名称;
将所述区域、所述项目名称、所述第三方系统名称、所述本系统名称和预设的固定字段进行拼接得到所述文档名称。
其中,区域表示接口代码适用的范围、项目名称表示接口代码所在的项目的名称,第三方系统名称表示与本系统的集成接口对接的第三方系统的名称,本系统名称表示开发集成接口的系统的名称。固定字段为预设的指定字段,将上述字段进行拼接得到文档名称。
在一个或多个可能的实施例中,所述需求文档包括:修订历史记录;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
解析所述接口代码的修订日志得到修订日期、版本号、修订方式、修订内容、需求人员和开发人员;
根据所述修订日期、所述版本号、所述修订内容、所述需求人员和所述开发人员生成所述修订历史记录。
其中,修订日期表示接口代码修订的日期,版本号表示接口代码的版本的序号,修订内容表示接口代码相对于上一版本的修改内容,需求人员表示接口代码的需求方的名称,开发人员表示开发该接口代码的人员的名称。
例如:修订历史记录以表格的方式表示,如表1所示:
表1
在一个或多个可能的实施例中,所述需求文档包括:集成可视化信息;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
根据所述接口代码的项目名称、PO表名、接口名称、业务类型、数据流向、交互系统、单位字段、摘要字段、唯一键和前台展示字段生成所述集成可视化信息。
其中,项目名称表示接口代码所在的项目的名称,又称为SA名称;PO表名表示接口代码所在的表格的名称;接口名称表示集成接口的名称;业务类型表示集成接口承载的业务的类型;数据流向包括本系统向第三方系统发送业务数据(即向外流动)和第三方系统向本系统发送业务数据(即向内流动);交互系统表示调用集成接口的系统名称;单位字段表示集成接口所在的单位的名称;摘要字段表示接口代码的摘要,唯一键表示接口代码的键值;前台展示字段表示集成接口中需要在前台进行显示的业务数据的字段。
例如:生成的集成可视化信息如表2所示:
表2
在一个或多个可能的实施例中,所述需求文档包括:接口规范信息;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
根据所述接口代码的接口提供方、接口调用方、接口地址、接口方法、调用方式、输入报文格式、输出报文格式生成所述接口规范信息。
其中,接口提供方表示提供集成接口的系统的名称,即本系统名称,接口调用方表示调用集成接口的系统的名称,接口方法表示调用集成接口的方法,例如,接口方法包括:POST或GOT等;调用地址表示集成接口的地址,一般使用URL地址来表示,调用方式包括restful或HTTPS或webservice等。例如:接口规范信息包括:
接口调用方:集成平台;
接口提供方:用户中心;
调用方式形式:restful;
接口地址:POST/necp/mapp/4a/api/interation/v1/org。
在一个或多个可能的实施例中,所述需求文档包括:集成流程图;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
获取所述接口代码的处理逻辑;
根据所述处理逻辑生成所述集成流程图。
其中,集成流程图用于展示接口调用关系,根据接口代码中的处理逻辑,完成从接收模块、处理模块和反馈模块获取信息,转换生成VISIO泳道流程图,每一个泳道为集成应用中涉及的接口提供方和接口调用方的展示,流程开始为接收模块中调用集成平台接口的系统为接口调用方,处理模块中集成平台调用的为数据接收方系统,反馈模块是将处理结果反馈给调用方,调用方接收反馈后,整个集成流程结束。
例如:参见图3所示的集成流程图,其中包括组织信息集成。
在一个或多个可能的实施例中,所述需求文档包括:字段对应关系和集成过程描述信息。
其中,字段对应关系以表格形式展示,一级列表头包括:源接口、目标接口、集成处理,源接口二级列表头包括:字段来源、字段、字段名称、类型,目标接口二级列表头包括:字段、字段名称、类型。集成处理包括以下几类:直接集成、映射、集成处理、默认值,集成处理的具体规则,需要根据集成代码处理逻辑获取,比如字段拼接、字段截取等。
例如:字段对应关系如表3所示:
表3
其中,根据接口代码中的实现逻辑,生成接收模块、处理模块、反馈模块的集成过程描述信息,各种分支流程判断。
例如:集成过程描述信息为:1、MDM系统调用集成平台接口;2、集成平台接收并解析,组装电子档案报文,调用接口;3、集成平台接收反馈,组装反馈报文,反馈MDM系统。4、集成平台更新可视化集成结果。集成平台设置有集成接口,为接口提供者,MDM系统为接口调用者。
本申请实施例的方案在执行时,在生成接口代码的需求文档时,基于检索界面进行检索得到包含一个或多个接口代码的检索结果,基于用户的选择指令从检索结果中选择一个接口代码,然后根据预设的生成规则生成该接口代码的需求文档,解决了相关技术中接口代码和需求文档不匹配的问题,在现有根据需求文档进行接口开发的基础上,基于规范的接口开发框架,实现反向根据接口代码自动生成需求文档的功能。
下述为本申请装置实施例,可以用于执行本申请方法实施例。对于本申请装置实施例中未披露的细节,请参照本申请方法实施例。
请参见图4,其示出了本申请一个示例性实施例提供的需求文档的生成装置的结构示意图,以下简称生成装置4。该生成装置4可以通过软件、硬件或者两者的结合实现成为电子设备的全部或一部分。生成装置4包括:显示单元401、查询单元402、选择单元403和生成单元404。
显示单元401,用于显示检索界面;
查询单元402,用于获取用户通过所述检索界面输入的检索条件,以及根据所述检索条件在接口代码集合中进行检索得到检索结果;
选择单元403,用于响应于用户的选择指令从所述检索结果中选择一个接口代码;
生成单元404,用于基于预设的生成规则生成所述接口代码的需求文档。
在一个或多个可能的实施例中,所述需求文档包括文档名称;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
获取所述接口代码的区域、项目名称、第三方系统名称和本系统名称;
将所述区域、所述项目名称、所述第三方系统名称、所述本系统名称和预设的固定字段进行拼接得到所述文档名称。
在一个或多个可能的实施例中,所述需求文档包括:修订历史记录;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
解析所述接口代码的修订日志得到修订日期、版本号、修订方式、修订内容、需求人员和开发人员;
根据所述修订日期、所述版本号、所述修订内容、所述需求人员和所述开发人员生成所述修订历史记录。
在一个或多个可能的实施例中,所述需求文档包括:集成可视化信息;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
根据所述接口代码的项目名称、PO表名、接口名称、业务类型、数据流向、交互系统、单位字段、摘要字段、唯一键和前台展示字段生成所述集成可视化信息。
在一个或多个可能的实施例中,所述需求文档包括:接口规范信息;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
根据所述接口代码的接口提供方、接口调用方、接口地址、接口方法、调用方式、输入报文格式、输出报文格式生成所述接口规范信息。
在一个或多个可能的实施例中,所述需求文档包括:集成流程图;
其中,所述基于预设的生成规则生成所述接口代码的需求文档,包括:
获取所述接口代码的处理逻辑;
根据所述处理逻辑生成所述集成流程图。
在一个或多个可能的实施例中,所述需求文档包括:字段对应关系和集成过程描述信息。
需要说明的是,上述实施例提供的生成装置4在执行需求文档的生成方法时,仅以上述各功能模块的划分进行举例说明,实际应用中,可以根据需要而将上述功能分配由不同的功能模块完成,即将设备的内部结构划分成不同的功能模块,以完成以上描述的全部或者部分功能。另外,上述实施例提供的需求文档的生成装置与需求文档的生成方法实施例属于同一构思,其体现实现过程详见方法实施例,这里不再赘述。
上述本申请实施例序号仅仅为了描述,不代表实施例的优劣。
本申请实施例还提供了一种计算机存储介质,所述计算机存储介质可以存储有多条指令,所述指令适于由处理器加载并执行如上述图2-图3所示实施例的方法步骤,具体执行过程可以参见图2-图3所示实施例的具体说明,在此不进行赘述。
本申请还提供了一种计算机程序产品,该计算机程序产品存储有至少一条指令,所述至少一条指令由所述处理器加载并执行以实现如上各个实施例所述的需求文档的生成方法。
请参见图5,为本申请实施例提供了一种电子设备的结构示意图。如图5所示,所述电子设备500可以包括:至少一个处理器501,至少一个网络接口504,用户接口503,存储器505,至少一个通信总线502。
其中,通信总线502用于实现这些组件之间的连接通信。
其中,用户接口503可以包括显示屏(Display)、摄像头(Camera),可选用户接口503还可以包括标准的有线接口、无线接口。
其中,网络接口504可选的可以包括标准的有线接口、无线接口(如WI-FI接口)。
其中,处理器501可以包括一个或者多个处理核心。处理器501利用各种借口和线路连接整个电子设备500内的各个部分,通过运行或执行存储在存储器505内的指令、程序、代码集或指令集,以及调用存储在存储器505内的数据,执行电子设备500的各种功能和处理数据。可选的,处理器501可以采用数字信号处理(Digital Signal Processing,DSP)、现场可编程门阵列(Field-Programmable GateArray,FPGA)、可编程逻辑阵列(ProgrammableLogic Array,PLA)中的至少一种硬件形式来实现。处理器501可集成中央处理器(CentralProcessing Unit,CPU)、图像处理器(Graphics Processing Unit,GPU)和调制解调器等中的一种或几种的组合。其中,CPU主要处理操作系统、用户界面和应用程序等;GPU用于负责显示屏所需要显示的内容的渲染和绘制;调制解调器用于处理无线通信。可以理解的是,上述调制解调器也可以不集成到处理器501中,单独通过一块芯片进行实现。
其中,存储器505可以包括随机存储器(RandomAccess Memory,RAM),也可以包括只读存储器(Read-Only Memory)。可选的,该存储器505包括非瞬时性计算机可读介质(non-transitory computer-readable storage medium)。存储器505可用于存储指令、程序、代码、代码集或指令集。存储器505可包括存储程序区和存储数据区,其中,存储程序区可存储用于实现操作系统的指令、用于至少一个功能的指令(比如触控功能、声音播放功能、图像播放功能等)、用于实现上述各个方法实施例的指令等;存储数据区可存储上面各个方法实施例中涉及到的数据等。存储器505可选的还可以是至少一个位于远离前述处理器501的存储装置。如图5所示,作为一种计算机存储介质的存储器505中可以包括操作系统、网络通信模块、用户接口模块以及适于由所述处理器加载并执行前述方法步骤的所述计算机程序。
在图5所示的电子设备500中,用户接口503主要用于为用户提供输入的接口,获取用户输入的数据;而处理器501可以用于调用存储器505中存储的触摸操作响应应用程序,并具体执行以下图2的方法实施例所述的步骤。具体过程可参照图2所示,此处不再赘述。
本领域普通技术人员可以理解实现上述实施例方法中的全部或部分流程,是可以通过计算机程序来指令相关的硬件来完成,所述的程序可存储于一计算机可读取存储介质中,该程序在执行时,可包括如上述各方法的实施例的流程。其中,所述的存储介质可为磁碟、光盘、只读存储记忆体或随机存储记忆体等。
以上所揭露的仅为本申请较佳实施例而已,当然不能以此来限定本申请之权利范围,因此依本申请权利要求所作的等同变化,仍属本申请所涵盖的范围。
- 上一篇:石墨接头机器人自动装卡簧、装栓机
- 下一篇:一种基于文本数据的标准化处理方法及设备