一种报表接口文档生成方法、装置、设备及可读存储介质与流程

1.本发明涉及计算机技术领域，特别涉及一种报表接口文档生成方法、装置、设备及可读存储介质。


背景技术：

2.传统的报表配置流程在进行开发时具有很长的开发流程，且由于每次进行报表配置之前都需要先定义接口文档，使得当报表接口发生改变时，就得重新对代码进行编译，进而得到接口对应的接口文档，使得后端人员的重复劳动也就越来越多，增加人力成本。
3.因此，现有的报表接口文档生成流程过于漫长、重复劳动过多，急需一种报表配置方法，用以解决现有技术中的报表配置方法过于流程化，以及浪费人力的技术问题。


技术实现要素：

4.有鉴于此，本发明的目的在于提供一种报表接口文档生成方法、装置、设备及可读存储介质，解决了现有技术中需要接口的更改不断更改代码，增大人力的技术问题。
5.为解决上述技术问题，本发明提供了一种报表接口文档生成方法，包括：
6.获取报表配置信息；其中，所述报表配置信息中包括视图查询信息；
7.根据所述视图查询信息配置sql查询脚本；其中，所述sql查询脚本用于实现报表业务逻辑；
8.根据所述sql查询脚本配置入参信息和出参信息；
9.根据所述入参信息和所述出参信息生成报表接口文档。
10.可选的，在所述根据所述sql查询脚本配置入参信息之后，还包括：
11.获取渲染模板；其中，所述渲染模板属于所述报表配置信息；
12.根据所述渲染模板对所述入参信息进行渲染。
13.可选的，在所述获取报表配置信息之后，还包括：
14.根据所述报表配置信息，生成可操作的树形可视化界面。
15.可选的，其特征在于，所述根据所述sql查询脚本配置出参信息，包括：
16.根据所述sql查询脚本配置所述出参信息的数据结构；其中，所述数据结构的配置包括对缺省字段配置和/或字段权限配置。
17.可选的，所述报表接口文档生成方法，还包括：
18.根据所述报表接口文档发送发布申请，以根据所述发布申请使用所述报表接口文档。
19.可选的，所述根据所述入参信息和所述出参信息生成报表接口文档之后，还包括：
20.对所述报表接口文档进行解析，得到对应的文本结构；
21.对所述文本结构进行解析，得到文本字段；
22.调用报表测试系统对所述文本字段进行测试，以确定所述报表接口文档是否存在异常。
23.本发明还提供一种报表接口文档生成装置，包括：
24.报表配置信息获取模块，用于获取报表配置信息；其中，所述报表配置信息中包括视图查询信息；
25.sql查询脚本获取模块，用于根据所述视图查询信息配置sql查询脚本；其中，所述sql查询脚本用于实现报表业务逻辑；
26.出入参配置模块，用于根据所述sql查询脚本配置入参信息和出参信息；
27.报表接口文档生成模块，用于根据所述入参信息和所述出参信息生成报表接口文档。
28.可选的，所述出入参配置模块之后，还包括：
29.渲染模板获取模块，用于获取渲染模板；其中，所述渲染模板属于所述报表配置信息；
30.入参信息渲染模块，用于根据所述渲染模板对所述入参信息进行渲染。
31.本发明还提供一种报表接口文档生成设备，包括：
32.存储器，用于存储计算机程序；
33.处理器，用于执行所述计算机程序时实现上述的报表接口文档生成方法的步骤。
34.本发明还提供一种可读存储介质，所述可读存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现上述的报表接口文档生成方法的步骤。
35.可见，本发明通过获取报表配置信息；其中，所述报表配置信息中包括视图查询信息；根据所述视图查询信息配置sql查询脚本；其中，所述sql查询脚本用于实现报表业务逻辑；根据所述sql查询脚本配置入参信息和出参信息；根据所述入参信息和所述出参信息生成报表接口文档。可见，本发明和现有技术中需要根据接口变化不断修改代码的技术方法相比，本发明提供的报表接口文档生成方法不需要根据接口的不同来对代码进行修改，当需要对报表进行配置时，只需要根据配置信息自动生成包括api接口的接口文档即可，不需要一直对代码进行修改以实现对报表的配置，极大减少了后端人员的重复劳动，加快了报表接口文档的生成速度。
36.此外，本发明还提供了一种报表接口文档生成装置、设备及可读存储介质，同样具有上述有益效果。
附图说明
37.为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。
38.图1为本发明实施例提供的一种报表接口文档生成方法的流程图；
39.图2为本发明实施例提供的一种报表接口文档生成方法的流程示例图；
40.图3为本发明实施例提供的一种报表接口文档生成装置的结构示意图；
41.图4为本发明实施例提供的一种报表接口文档生成设备的结构示意图。
具体实施方式
42.为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。
43.请参考图1，图1为本发明实施例提供的报表接口文档生成方法的流程图。该方法可以包括：
44.s100，获取报表配置信息；其中，报表配置信息中包括视图查询信息。
45.该实施例并不限定报表配置信息的具体内容。例如，报表配置信息可以包括视图模板和视图查询信息，或者报表配置信息可以包括唯一标识、视图模板和视图查询信息，其中，视图模板可以是基于基础角色权限范围内的入参脚本，或者按部门数据进行数据补全的方式；或者报表配置信息可以是字段类型和视图查询信息。该实施例并不限定具体的视图查询信息，只要可以根据该视图查询信息对sql(structuredquerylanguage，结构化查询语言)查询脚本进行配置即可。例如，视图查询信息可以是返回数值列表，或者视图查询信息可以是分页形式。
46.s101，根据视图查询信息配置sql查询脚本；其中，sql查询脚本用于实现报表业务逻辑。
47.该实施例并不限定sql查询脚本的具体内容，只要能够实现报表业务逻辑即可。该实施例中的sql查询脚本可以是基于sqlxml(extensiblemarkuplanguage，可扩展标记语言)编译的可执行的sql查询脚本，该实施例sql查询脚本也可以是基于sqlxml编译的包括企业对应的相关员工的信息，该实施例中sql查询脚本还可以是基于sqlxml编译的企业资金流的信息。
48.s102，根据sql查询脚本配置入参信息和出参信息。
49.该实施例并不限定根据sql查询脚本配置入参信息的具体内容。例如，根据sql查询脚本配置入参信息可以是配置入参信息的类型，或者根据sql查询脚本配置入参信息可以配置入参信息的格式，或者根据sql查询脚本配置入参信息可以配置入参信息的等级。该实施例并不限定根据sql查询脚本配置出参信息的具体内容。例如，根据sql查询脚本配置出参信息的名称，或者根据sql查询脚本配置出参信息的字段类型，或者根据sql查询脚本配置出参信息的展示格式；或者根据sql查询脚本配置出参信息的展示日期。
50.s103，根据入参信息和出参信息生成报表接口文档。
51.该实施例并不限定根据入参信息和出参信息生成报表接口文档的具体内容，只要生成的报表接口文档中包括各种接口文档即可。例如生成报表接口文档可以包括字段接口和数据接口，或者生成报表接口文档可以包括api接口(applicationprogramminginterface，应用程序编程接口)、http接口(hyper texttransferprotocol，超文本传输协议接口)和dubbo(微服务框架)接口。
52.基于上述实施方案，本发明通过获取报表配置信息；其中，报表配置信息中包括视图查询信息；根据视图查询信息配置sql查询脚本；其中，sql查询脚本用于实现报表业务逻辑；根据sql查询脚本配置入参信息和出参信息；根据入参信息和出参信息生成报表接口文档。可见，本发明和现有技术中需要根据接口变化不断修改代码的技术方法相比，本发明提
供的报表接口文档生成方法不需要根据接口的不同来对代码进行修改，当需要对报表进行配置时，只需要根据配置信息自动生成包括api接口的接口文档即可，不需要一直对代码进行修改以实现对报表的配置，极大减少了后端人员的重复劳动，加快了报表接口文档的生成速度。
53.进一步，为了对入参信息进行渲染，实现对入参信息的快速整理，在上述根据sql查询脚本配置入参信息之后，还可以包括：
54.获取渲染模板；其中，渲染模板属于报表配置信息；
55.根据渲染模板对入参信息进行渲染。
56.该实施例并不限定渲染模板的具体类型，只要可以对入参信息进行渲染即可。渲染模板的作用机制可以简单理解为文本替换操作，使用相应的数据去替换html(hypertextmarkuplanguage，超文本标记语言)文档中事先准备好的标记。例如，渲染模板可以包括根元素编译模板和列表渲染。或者渲染模板可以是gin模板，该gin模板可以包括定义模板文件、解析模板文件和模板渲染模块。
57.进一步，为了增加生成报表接口文档中一系列操作的方便性，在上述获取报表配置信息之后，还可以包括：
58.根据报表配置信息，生成可操作的树形可视化界面。
59.该实施例并不限定具体的树形可视化操作界面，只要根据报表配置信息生成可操作的树形可视化界面可以对sql查询脚本进行编辑，以及对出参信息进行配置，以及对出参信息进行配置即可。树形可视化界面和其他界面相比，更加清晰，进行各种操作更加方便。
60.进一步，为了对出参信息中的数据结构进行配置，增加出参信息的一致性，上述根据sql查询脚本配置出参信息，可以包括：
61.根据sql查询脚本配置出参信息的数据结构；其中，数据结构的配置包括对缺省字段配置和/或字段权限配置。
62.该实施例可以根据sql查询脚本配置出参信息的数据结构，数据结构的配置包括对缺省字段配置和/或字段权限配置。该实施例并不限定具体缺省字段的设置，例如可以将缺省字段定义为空值，或者将缺省字段定义为*。该实施例并不限定字段权限配置的具体方式。例如，可以将身份证号设置为“***”，只要具有查看权限的人员才可以查看身份证号，没有权限的人员看到的身份信息是“****”。或者可以将员工工资进行字段权限设置，具有权限的主体可以查看员工具体的工资数额，没有权限的主体查看到的工资为“***”。
63.进一步，为了快速对报表接口文档进行发布，上述报表接口文档生成方法，还可以包括：
64.根据报表接口文档发送发布申请，以根据发布申请使用报表接口文档。
65.该实施例中当自动生成报表接口文档时，就表示前端已经对开发完成，此时，只要发起申请，就可以对该报表接口文档进行发布。该实施例并不限定根据报表接口文档发布申请后执行的动作，例如，在发送发布申请后，可以存储该报表接口文档，或者在发送发布申请后可以发送提示信息，以提示报表接口文档已成功生成。
66.进一步，为了对报表接口文档进行及时的异常检测，上述根据入参信息和出参信息生成报表接口文档之后，还可以包括：
67.对报表接口文档进行解析，得到对应的文本结构；
68.对文本结构进行解析，得到文本字段；
69.调用报表测试系统对文本字段进行测试，以确定报表接口文档是否存在异常。
70.该实施例并不限定根据报表接口文档进行解析后得到的具体文本结构，只要是报表接口文档对应的文本结构即可。例如，文本结构可以是出参信息字段名称，或者文本结构可以是入参信息字段名称。该实施例并不限定对文本结构进行解析后得到的文本字段的具体内容，只要是文本结构对应的文本字段即可。该实施例中的文本字段可以是年龄字段，或者该实施例中的文本字段可以是工作部门字段。该实施例中的报表测试系统是根据需求设置的测试系统，该实施例并不限定报表测试系统的具体内容，只要可以是对生成的报表接口文档进行测试即可。例如，测试报表接口文档的出参信息中的出参字段是否正确；或者测试报表接口文档的出参信息中的数据查看权限是否正确。通过对生成的报表接口文档进行测试，可以及时发现报表接口文档中的异常，及时对异常信息进行修改，防止报表接口文档发布后再发现错误，影响对报表接口文档修改的速度。
71.为了使本发明更便于理解，具体请参考图2，图2为本发明实施例提供的报表接口文档生成方法的流程示例图，具体可以包括：
72.本发明实施例中的主要分为开发过程和发布过程。其中，开发过程包括创建视图，创建的视图中可以包括视图模板、视图查询和视图名称，创建视图后可以得到相关的报表配置信息。进而可以是根据报表配置信息，配置sql查询脚本，即sqlxml，配置完成sqlxml后就可以对出参信息和入参信息进行配置，例如，可以配置出参信息的时间类型、客户等级和客户来源等。在配置完出参信息和入参信息后就可以自动生成报表接口文档，此时，代表前端开发已经完成，需要对报表接口文档进行发布。在对报表接口文档进行发布时，不需要像现有技术一样进行打包，就可以直接发起申请，进而发布审批。
73.应用本发明实施例提供的报表接口文档生成方法，可以获取报表配置信息；其中，报表配置信息中包括视图查询信息；根据视图查询信息配置sql查询脚本；其中，sql查询脚本用于实现报表业务逻辑；根据sql查询脚本配置入参信息和出参信息；根据入参信息和所述出参信息生成报表接口文档。本发明和现有技术中需要根据接口变化不断修改代码的技术方法相比，本发明提供的报表接口文档生成方法不需要根据接口的不同来对代码进行修改，当需要对报表进行配置时，只需要根据配置信息自动生成包括api接口的接口文档即可，不需要一直对代码进行修改以实现对报表的配置，极大减少了后端人员的重复劳动，加快了报表接口文档的生成速度。并且，由于可以对入参进行渲染，使得可以满足用户的多样化需求；并且可以生成树形可视化界面，使得对出入参的配置更加方便更加快速；并且可以对出参信息的数据结构进行配置，使得出参的类型更加多样化，更加一致，更加快速便捷；并且，在得到报表接口文档时可以直接进行发布申请，省略了打包的过程，加快了报表接口文档的发布速度；并且，可以通过调用报表测试系统对报表的异常信息进行检测，加快了异常信息发现的速度，使得对异常报表接口文档的处理更加快速。
74.下面对本发明实施例提供的报表接口文档生成装置进行介绍，下文描述的报表接口文档生成装置与上文描述的报表接口文档生成方法可相互对应参照。
75.具体请参考图3，图3为本发明实施例提供的报表接口文档生成装置的结构示意图，可以包括：
76.报表配置信息获取模块100，用于获取报表配置信息；其中，所述报表配置信息中
包括视图查询信息；
77.sql查询脚本获取模块200，用于根据所述视图查询信息配置sql查询脚本；其中，所述sql查询脚本用于实现报表业务逻辑；
78.出入参配置模块300，用于根据所述sql查询脚本配置入参信息和出参信息；
79.报表接口文档生成模块400，用于根据所述入参信息和所述出参信息生成报表接口文档。
80.进一步，基于上述实施例，所述出入参配置模块之后，还可以包括：
81.渲染模板获取模块，用于获取渲染模板；其中，所述渲染模板属于所述报表配置信息；
82.入参信息渲染模块，用于根据所述渲染模板对所述入参信息进行渲染。
83.进一步，基于上述任意实施例，在上述报表配置信息获取模块100之后，还可以包括：
84.可视化界面生成模块，用于根据所述报表配置信息，生成可操作的树形可视化界面。
85.进一步，基于上述任意实施例，上述出入参配置模块300，可以包括：
86.数据接口配置单元，用于根据所述sql查询脚本配置所述出参信息的数据结构；其中，所述数据结构的配置包括对缺省字段配置和/或字段权限配置。
87.进一步，基于上述任意实施例，上述报表接口文档生成装置，还可以包括：
88.发布申请模块，用于根据所述报表接口文档发送发布申请，以根据所述发布申请使用所述报表接口文档。
89.进一步，基于上述任意实施例，上述报表接口文档生成模块400之后，还可以包括：
90.文本结构获取模块，用于对所述报表接口文档进行解析，得到对应的文本结构；
91.文本字段获取模块，用于对所述文本结构进行解析，得到文本字段；
92.异常判断模块，用于调用报表测试系统对所述文本字段进行测试，以确定所述报表接口文档是否存在异常。
93.需要说明的是，上述报表接口文档生成装置中的模块以及单元在不影响逻辑的情况下，其顺序可以前后进行更改。
94.应用本发明实施例提供的报表接口文档生成方法，通过报表配置信息获取模块100，用于获取报表配置信息；其中，所述报表配置信息中包括视图查询信息；sql查询脚本获取模块200，用于根据所述视图查询信息配置sql查询脚本；其中，所述sql查询脚本用于实现报表业务逻辑；出入参配置模块300，用于根据所述sql查询脚本配置入参信息和出参信息；报表接口文档生成模块400，用于根据所述入参信息和所述出参信息生成报表接口文档。可见，本发明提供的报表接口文档生成装置和现有技术中需要根据接口变化不断修改代码的技术方法相比，本发明提供的报表接口文档生成装置不需要根据接口的不同来对代码进行修改，当需要对报表进行配置时，只需要根据配置信息自动生成包括api接口的接口文档即可，不需要一直对代码进行修改以实现对报表的配置，极大减少了后端人员的重复劳动，加快了报表接口文档的生成速度。并且，由于入参信息渲染模块可以对入参进行渲染，使得可以满足用户的多样化需求；并且可视化界面生成模块可以根据报表配置信息生成树形可视化界面，使得对出入参的配置更加方便；并且可以对出参信息的数据结构进行
配置，使得出参的类型更加多样化，出参格式更加一致，更加快速便捷；并且，在得到报表接口文档时可以直接进行发布申请，省略了打包的过程，加快了报表接口文档的发布速度；并且，可以通过调用报表测试系统对报表的异常信息进行检测，加快了异常信息发现的速度，使得对异常报表接口文档的处理更加快速。
95.下面对本发明实施例提供的报表接口文档生成设备进行介绍，下文描述的报表接口文档生成设备与上文描述的报表接口文档生成方法可相互对应参照。
96.请参考图4，图4为本发明实施例提供的报表接口文档生成设备的结构示意图，可以包括：
97.存储器10，用于存储计算机程序；
98.处理器20，用于执行计算机程序，以实现上述的报表接口文档生成方法的步骤。
99.存储器10、处理器20、通信接口31和通信总线32。存储器10、处理器20、通信接口31均通过通信总线32完成相互间的通信。
100.在本发明实施例中，存储器10中用于存放一个或者一个以上程序，程序可以包括程序代码，程序代码包括计算机操作指令，在本技术实施例中，存储器10中可以存储有用于实现以下功能的程序：
101.获取报表配置信息；其中，所述报表配置信息中包括视图查询信息；
102.根据所述视图查询信息配置sql查询脚本；其中，所述sql查询脚本用于实现报表业务逻辑；
103.根据所述sql查询脚本配置入参信息和出参信息；
104.根据所述入参信息和所述出参信息生成报表接口文档。
105.在一种可能的实现方式中，存储器10可包括存储程序区和存储数据区，其中，存储程序区可存储操作系统，以及至少一个功能所需的应用程序等；存储数据区可存储使用过程中所创建的数据。
106.此外，存储器10可以包括只读存储器和随机存取存储器，并向处理器提供指令和数据。存储器的一部分还可以包括nvram。存储器存储有操作系统和操作指令、可执行模块或者数据结构，或者它们的子集，或者它们的扩展集，其中，操作指令可包括各种操作指令，用于实现各种操作。操作系统可以包括各种系统程序，用于实现各种基础任务以及处理基于硬件的任务。
107.处理器20可以为中央处理器(centralprocessingunit，cpu)、特定应用集成电路、数字信号处理器、现场可编程门阵列或者其他可编程逻辑器件，处理器20可以是微处理器或者也可以是任何常规的处理器等。处理器20可以调用存储器10中存储的程序。
108.通信接口31可以为通信模块的接口，用于与其他设备或者系统连接。
109.当然，需要说明的是，图4所示的结构并不构成对本技术实施例中报表接口文档生成设备的限定，在实际应用中报表接口文档生成设备可以包括比图4所示的更多或更少的部件，或者组合某些部件。
110.下面对本发明实施例提供的可读存储介质进行介绍，下文描述的可读存储介质与上文描述的报表接口文档生成方法可相互对应参照。
111.本发明还提供一种可读存储介质，该可读存储介质上存储有计算机程序，计算机程序被处理器执行时实现上述的报表接口文档生成方法的步骤。
112.该可读存储介质可以包括：u盘、移动硬盘、只读存储器(read-only memory，rom)、随机存取存储器(randomaccessmemory，ram)、磁碟或者光盘等各种可以存储程序代码的介质。
113.本说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其它实施例的不同之处，各个实施例之间相同或相似部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。
114.专业人员还可以进一步意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、计算机软件或者二者的结合来实现，为了清楚地说明硬件和软件的可互换性，在上述说明中已经按照功能一般性地描述了各示例的组成及步骤。这些功能究竟以硬件还是软件的方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应该认为超出本发明的范围。
115.最后，还需要说明的是，在本文中，诸如第一和第二等之类的关系属于仅仅用来将一个实体或者操作与另一个实体或者操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其他任何变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。
116.以上对本发明所提供的报表接口文档生成方法、装置、设备和可读存储介质进行了详细介绍，本文中应用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想；同时，对于本领域的一般技术人员，依据本发明的思想，在具体实施方式及应用范围上均会有改变之处，综上所述，本说明书内容不应理解为对本发明的限制。