一种接口文档的生成方法、装置、电子设备及存储介质制造方法及图纸

本申请提供了一种接口文档的生成方法、装置、电子设备及存储介质，获取用户在设计界面上配置的图表组件系统，针对每个图表组件单元，响应用户针对该图表组件单元的第一配置指令，显示对应的接口配置界面，针对接口配置界面上的每个配置数据项，获取用户针对该图表组件单元输入的接口属性信息；针对每个图表组件单元，根据该图表组件单元对应的接口属性信息，按照预设规则生成该图表组件单元对应的接口属性数据；针对每个图表组件单元，对该图表组件单元对应的接口属性数据进行解析，以生成图表组件系统的接口文档，帮助前端用户在设计界面上创建图表组件系统的同时自动生成对应的接口文档，以提高接口文档的编写效率。以提高接口文档的编写效率。以提高接口文档的编写效率。

【技术实现步骤摘要】
一种接口文档的生成方法、装置、电子设备及存储介质


[0001]本申请涉及组态软件
，具体而言，涉及一种接口文档的生成方法、装置、电子设备及存储介质。

技术介绍

[0002]现有技术中，云组态应用的使用流程包括前端设计和后端研发，组态应用的图表组件系统用于展示的业务数据，但业务数据需要通过后台服务接口提供，涉及到前后台交互的部分，则需要编写接口文档来指导开发对应的后台程序。通常接口文档由人工编写，这样就出现了编写效率过低的问题。

技术实现思路

[0003]有鉴于此，本申请的目的在于提供一种接口文档的生成方法、装置、电子设备及存储介质，帮助前端用户在设计界面上创建图表组件系统的同时自动生成对应的接口文档，以提高接口文档的编写效率。
[0004]第一方面，本申请实施例提供一种接口文档的生成方法，包括：获取用户在设计界面上配置的图表组件系统，图表组件系统包括至少一个图表组件单元；针对每个图表组件单元，响应用户针对该图表组件单元的第一配置指令，显示对应的接口配置界面，第一配置指令用于触发图表组件单元对应的接口配置界面，接口配置界面上包括多个配置数据项，针对接口配置界面上的每个配置数据项，获取用户针对该图表组件单元输入的接口属性信息；针对每个图表组件单元，根据该图表组件单元对应的接口属性信息，按照预设规则生成该图表组件单元对应的接口属性数据；针对每个图表组件单元，对该图表组件单元对应的接口属性数据进行解析，以生成图表组件系统的接口文档。
[0005]优选地，接口属性信息至少包括接口名称、接口请求方式、接口请求地址、参数信息和数据映射规则。
[0006]优选地，接口属性数据包括多条数据，每条数据与接口配置界面上的一个配置数据项对应，每条数据包括接口属性名称和接口属性名称对应的数据值，其中，根据每个图表组件单元所获取的接口属性信息，按照预设规则生成该图表组件单元对应的接口属性数据的步骤，具体包括：基于接口请求地址生成requestUrl对应的数据值；基于接口请求方式生成requestType对应的数据值；数据映射规则包括数据外层映射规则和数据内层映射规则，还包括：基于数据集外层映射规则生成dataSetRule对应的数据值；其中，数据集内层映射规则至少包括X轴映射、Y轴映射或内容映射中的一个，还包括：基于X轴映射生成xAxisRule对应的数据值，以及基于Y轴映射生成yAxisRule对应的数据值；或基于内容映射生成contentRule对应的数据值；参数信息包括静态参数、动态参数和URL参数中的至少一个，还包括：基于静态参数生成staticParam对应的数据值；和/或基于动态参数生成dynamicParam对应的数据值；和/或基于URL参数生成urlParam对应的数据值。
[0007]优选地，针对每个图表组件单元，对该图表组件单元对应的接口属性数据进行解
析，以生成图表组件系统的接口文档的步骤，具体包括：生成表格文档，表格文档包括预设表头和数据单元格；针对每个接口属性数据，解析出预设接口属性和预设接口属性对应的数据值，根据预设接口属性和预设表头的对应关系，将预设接口属性对应的数据值记录到目标数据单元格中。
[0008]优选地，预设表头包括请求地址、请求方式、返回数据格式和接口配置参数，根据预设接口属性和预设表头的对应关系，将预设接口属性对应的数据值记录到目标数据单元格中的步骤之前，还包括：确定当前的接口属性数据中requestUrl对应的数据值和requestType对应的数据值是否存在；若都存在，则确定当前的第一存储信息中xAxisRule对应的数据值或contentRule对应的数据值是否存在；若存在，则执行根据预设接口属性和预设表头的对应关系，将预设接口属性对应的数据值记录到目标数据单元格中的步骤；若不存在，则跳过该接口属性数据。
[0009]优选地，根据预设接口属性和预设表头的对应关系，将预设接口属性对应的数据值记录到目标数据单元格中的步骤，具体包括：将requestUrl对应的数据值记录在请求地址对应的数据单元格中；将requestType对应的数据值记录在请求方式对应的数据单元格中；根据dataSetRule对应的数据值生成数据格式的外层格式，以及根据xAxisRule对应的数据值或contentRule对应的数据值生成数据格式的内层格式；根据数据格式的外层格式和数据格式的内层格式生成完整的数据格式，并记录在返回数据格式对应的数据单元格中；将staticParam对应的数据值、dynamicParam对应的数据值、urlParam对应的数据值中的一个，记录在预设参数对应的数据单元格中。
[0010]优选地，图表组件系统还包括背景画板，还包括：当响应用户对设计界面上的第一控件的触发指令时，根据每个图表组件单元的图形属性信息，按照预设规则生成图形属性数据，以及根据背景画板对应的背景属性信息，按照预设规则生成背景属性数据；根据每个图表组件单元的对应的接口属性数据和图形属性数据，以及背景画板对应的背景属性数据，生成当前图表组件系统对应的存储数据。
[0011]第二方面，本申请实施例还提供一种接口文档的生产装置，包括：
[0012]获取模块，用于获取用户在设计界面上配置的图表组件系统，图表组件系统包括至少一个图表组件单元；
[0013]响应模块，用于针对每个图表组件单元，响应用户针对该图表组件单元的第一配置指令，显示对应的接口配置界面，第一配置指令用于触发图表组件单元对应的接口配置界面，接口配置界面上包括多个配置数据项，针对接口配置界面上的每个配置数据项，获取用户针对该图表组件单元输入的接口属性信息；
[0014]生成模块，用于针对每个图表组件单元，根据该图表组件单元对应的接口属性信息，按照预设规则生成该图表组件单元对应的接口属性数据；
[0015]解析模块，用于针对每个图表组件单元，对该图表组件单元对应的接口属性数据进行解析，以生成图表组件系统的接口文档。
[0016]第三方面，本申请实施例还提供一种电子设备，包括：处理器、存储器和总线，存储器存储有处理器可执行的机器可读指令，当电子设备运行时，处理器与存储器之间通过总线通信，处理器执行机器可读指令，以执行如上所述的接口文档的生成方法的步骤。
[0017]第四方面，本申请实施例还提供一种计算机可读存储介质，存储介质上存储有计
算机程序，计算机程序被处理器运行时执行如上所述的接口文档的生成方法的步骤。
[0018]本申请实施例提供的一种接口文档的生成方法、装置、电子设备及存储介质，通过获取用户在设计界面上配置的图表组件系统，图表组件系统包括至少一个突变组件单元，针对每个图表组件单元，响应用户针对该图表组件单元的第一配置指令，显示对应的接口配置界面，接口配置界面上包括多个配置数据项，用户在每个配置项中输入所需要的接口属性信息后，可以获取用户针对该图表组件单元输入的接口属性信息，当用户需要生成接口文档时，针对每个图表组件单元，根据该图表组件单元对应的接口属本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档的生成方法，其特征在于，包括：获取用户在设计界面上配置的图表组件系统，所述图表组件系统包括至少一个图表组件单元；针对每个图表组件单元，响应用户针对该图表组件单元的第一配置指令，显示对应的接口配置界面，所述第一配置指令用于触发图表组件单元对应的接口配置界面，所述接口配置界面上包括多个配置数据项，针对所述接口配置界面上的每个配置数据项，获取用户针对该图表组件单元输入的接口属性信息；针对每个图表组件单元，根据该图表组件单元对应的接口属性信息，按照预设规则生成该图表组件单元对应的接口属性数据；针对每个图表组件单元，对该图表组件单元对应的接口属性数据进行解析，以生成所述图表组件系统的接口文档。2.根据权利要求1所述的方法，其特征在于，所述接口属性信息至少包括接口名称、接口请求方式、接口请求地址、参数信息和数据映射规则。3.根据权利要求2所述的方法，其特征在于，所述接口属性数据包括多条数据，每条数据与接口配置界面上的一个配置数据项对应，每条数据包括接口属性名称和接口属性名称对应的数据值，其中，所述根据每个图表组件单元所获取的接口属性信息，按照预设规则生成该图表组件单元对应的接口属性数据的步骤，具体包括：基于接口请求地址生成requestUrl对应的数据值；基于接口请求方式生成requestType对应的数据值；所述数据映射规则包括数据外层映射规则和数据内层映射规则，还包括：基于数据集外层映射规则生成dataSetRule对应的数据值；其中，所述数据集内层映射规则至少包括X轴映射、Y轴映射或内容映射中的一个，还包括：基于X轴映射生成xAxisRule对应的数据值，以及基于Y轴映射生成yAxisRule对应的数据值；或基于内容映射生成contentRule对应的数据值；所述参数信息包括静态参数、动态参数和URL参数中的至少一个，还包括：基于静态参数生成staticParam对应的数据值；和/或基于动态参数生成dynamicParam对应的数据值；和/或基于URL参数生成urlParam对应的数据值。4.根据权利要求3所述的方法，其特征在于，所述针对每个图表组件单元，对该图表组件单元对应的接口属性数据进行解析，以生成所述图表组件系统的接口文档的步骤，具体包括：生成表格文档，所述表格文档包括预设表头和数据单元格；针对每个接口属性数据，解析出预设接口属性和预设接口属性对应的数据值，根据预设接口属性和预设表头的对应关系，将预设接口属性对应的数据值记录到目标数据单元格中。5.根据权利要求4所述的方法，其特征在于，所述预设表头包括请求地址、请求方式、返
回数据格式和接口配置参数，所述根据预设接口属性和预设表头的对应关系，将预设接口属性对应的数据值记录到目标数据单元格中的步骤之前，还包括：确定当前的接口属性数据中requestUrl对应的数据值和requestType对应的数据值是否存在；若都存在，则...

【专利技术属性】
技术研发人员：李洪浩，王璐，何渝君，陈勋，管飞，张婧，陈盼，王超，段奇，邬明罡，
申请(专利权)人：瀚云科技有限公司，
类型：发明
国别省市：