(19)国家知识产权局 (12)发明 专利申请 (10)申请公布号 (43)申请公布日 (21)申请 号 202210110405.5 (22)申请日 2022.01.29 (71)申请人 瀚云科技有限公司 地址 214000 江苏省无锡市无锡新区新吴 区菱湖大道111号无锡软件园天鹅座B 栋1111室 (72)发明人 李洪浩　王璐　何渝君　陈勋　 管飞　张婧　陈盼　王超　段奇　 邬明罡　 (74)专利代理 机构 北京超凡宏宇专利代理事务 所(特殊普通 合伙) 11463 专利代理师 刘凤 (51)Int.Cl. G06F 16/904(2019.01) G06F 9/451(2018.01)G06F 16/955(2019.01) G06T 11/20(2006.01) (54)发明名称 一种接口文档的生成方法、 装置、 电子设备 及存储介质 (57)摘要 本申请提供了一种接口文档的生 成方法、 装 置、 电子设备及存储介质， 获取用户在设计界面 上配置的图表组件系统， 针对每个图表组件单 元， 响应用户针对该图表组件单元的第一配置指 令， 显示对应的接口配置界面， 针对接口配置界 面上的每个配置数据项， 获取用户针对该图表组 件单元输入的接口属性信息； 针对每个图表组件 单元， 根据该图表组件单元对应的接口属性信 息， 按照预设规则生成该图表组件 单元对应的接 口属性数据； 针对每个图表组件单元， 对该图表 组件单元对应的接口属性数据进行解析， 以生成 图表组件系统的接口文档， 帮助前端用户在设计 界面上创建图表组件系统的同时自动生成对应 的接口文档， 以提高接口文档的编写效率。 权利要求书3页 说明书10页 附图4页 CN 114491191 A 2022.05.13 CN 114491191 A 1.一种接口文档的生成方法， 其特 征在于， 包括： 获取用户在 设计界面上配置的图表 组件系统， 所述图表 组件系统包括至少一个图表 组 件单元； 针对每个图表组件单元， 响应用户针对该图表组件单元的第一配置指令， 显示对应的 接口配置界面， 所述第一配置指令用于触发 图表组件单元对应的接口配置界面， 所述接口 配置界面上包括多个配置数据项， 针对所述接口配置界面上 的每个配置数据项， 获取用户 针对该图表组件单 元输入的接口属性信息； 针对每个图表组件单元， 根据该图表组件单元对应的接口属性信息， 按照预设规则生 成该图表组件单 元对应的接口属性数据； 针对每个图表组件单元， 对该图表组件单元对应的接口属性数据进行解析， 以生成所 述图表组件系统的接口文档。 2.根据权利要求1所述的方法， 其特征在于， 所述接口属性信息至少包括接口名称、 接 口请求方式、 接口请求 地址、 参数信息和数据映射 规则。 3.根据权利要求2所述的方法， 其特征在于， 所述接口属性数据包括多条数据， 每条数 据与接口配置界面上的一个配置数据项对应， 每条数据包括接口属性名称和接口属性名称 对应的数据值， 其中， 所述根据每个图表组件单元所获取的接口属性信息， 按照预设规则生成该图表 组件单元对应的接口属性数据的步骤， 具体包括： 基于接口请求 地址生成requestUrl对应的数据值； 基于接口请求方式生成requestType对应的数据值； 所述数据映射 规则包括数据外层映射 规则和数据内层映射 规则， 还包括： 基于数据集外层映射 规则生成dataSetRule对应的数据值； 其中， 所述数据集内层映射规则至少包括X轴映射、 Y轴映射或内容映射中的一个， 还包 括： 基于X轴映射生成xAxisRule对应的数据值， 以及基于Y轴映射生成yAxisRule对应的数 据值； 或 基于内容映射 生成contentRule对应的数据值； 所述参数信息包括静态参数、 动态参数和URL 参数中的至少一个， 还 包括： 基于静态参数生成staticParam对应的数据值； 和/或 基于动态参数生成dynamicParam对应的数据值； 和/或 基于URL参数生成urlParam对应的数据值。 4.根据权利要求3所述的方法， 其特征在于， 所述针对每个图表组件单元， 对该图表组 件单元对应的接口属 性数据进行解析， 以生成所述图表组件系统的接口文档的步骤， 具体 包括： 生成表格文档， 所述表格文档包括预设表头和数据单 元格； 针对每个接口属性数据， 解析出预设接口属性和预设接口属性对应的数据值， 根据预 设接口属性和预设表头的对应关系， 将预设接口属性对应的数据值记录到目标数据单元格 中。 5.根据权利要求4所述的方法， 其特征在于， 所述预设表头包括请求地址、 请求方式、 返权　利　要　求　书 1/3 页 2 CN 114491191 A 2回数据格式和接口配置参数， 所述根据预设接口属 性和预设表头的对应关系， 将预设接口 属性对应的数据值记录 到目标数据单元格中的步骤之前， 还 包括： 确定当前的接口属性数据中requestUrl对应的数据值和requestType对应的数据值是 否存在； 若都存在， 则确定当前的第一存储信息中xAxisRule对应的数据值或contentRule对应 的数据值是否存在； 若存在， 则执行所述根据预设接口属性和预设表头的对应关系， 将预设接口属性对应 的数据值记录 到目标数据单元格中的步骤； 若不存在， 则跳过 该接口属性数据。 6.根据权利要求5所述的方法， 其特征在于， 所述根据预设接口属性和预设表头的对应 关系， 将预设接口属性对应的数据值记录 到目标数据单元格中的步骤， 具体包括： 将requestUrl对应的数据值记录在请求 地址对应的数据单 元格中； 将requestType对应的数据值记录在请求方式对应的数据单 元格中； 根据dataS etRule对应的数据值生成数据格式的外层格式， 以及根据xAxisRule对应的 数据值或co ntentRule对应的数据值 生成数据格式的内层格式； 根据数据格式的外层格式和数据格式的内层格式生成完整的数据格式， 并记录在返回 数据格式对应的数据单 元格中； 将staticParam对应的数据值、 dynamicParam对应的数据值、 urlParam对应的数据值中 的一个， 记录在预设参数对应的数据单 元格中。 7.根据权利要求1所述的方法， 其特征在于， 所述图表组件系统还包括背景画板， 还包 括： 当响应用户对所述设计界面上的第 一控件的触发指令时， 根据每个所述图表 组件单元 的图形属 性信息， 按照预设规则生成 图形属性数据， 以及根据所述背景画板对应的背景属 性信息， 按照预设规则生成背景属性数据； 根据每个图表 组件单元的对应的接口属性数据和图形属性数据， 以及所述背景画板对 应的背景属性数据， 生成当前图表组件系统对应的存 储数据。 8.一种接口文档的生成装置， 其特 征在于， 包括： 获取模块， 用于获取用户在设计界面上配置的图表组件系统， 所述图表组件系统包括 至少一个图表组件单 元； 响应模块， 用于针对每个图表组件单元， 响应用户针对该图表组件单元的第一配置指 令， 显示对应的接口配置界面， 所述第一配置指令用于触发 图表组件单元对应的接口配置 界面， 所述接口配置界面上包括多个配置数据项， 针对所述接口配置界面上 的每个配置数 据项， 获取用户针对该图表组件单 元输入的接口属性信息； 生成模块， 用于针对每个图表 组件单元， 根据 该图表组件单元对应的接口属性信 息， 按 照预设规则生成该图表组件单 元对应的接口属性数据； 解析模块， 用于针对每个图表组件单元， 对该图表组件单元对应的接口属性数据进行 解析， 以生成所述图表组件系统的接口文档。 9.一种电子设备， 其特征在于， 包括： 处理器、 存储器和总线， 所述存储器存储有所述处 理器可执行 的机器可读指令， 当电子设备运行时， 所述处理器与所述存储器之间通过总线权　利　要　求　书 2/3 页 3 CN 114491191 A 3