[发明专利]生成展示接口文档的系统、方法及介质

说明书

本发明提供了一种生成展示接口文档的系统、方法及介质，包括：数据解析模块：将全量数据依据数据之间的联系进行解析拆分，同时过滤掉预设范围内的重复数据；数据展示模块：在界面编辑参数示例发送接口请求并展示相应数据；文档导出模块：生成所需项目的接口文档并导出，导出的接口文档内容格式根据需求进行设置编辑。本发明解决了当前不同项目接口文档不能统一观看、数据展示交互不友好、不可版本对比等问题，本发明可以浏览不同项目的接口文档、并且导出不同格式的文档，还能进行接口文档的历史版本对比、接口调用测试。

技术领域

本发明涉及计算机应用技术领域，具体地，涉及一种生成展示接口文档的系统、方法及介质。

背景技术

当前技术条件下大多数接口文档一部分是通过方式一：服务端配置一些生成文档的插件，设置一些参数启动服务后会输出一个文档地址，一部分是通过方式二：服务器获取脚本对象符号形式的接口文档，对脚本对象符号形式的接口文档进行解析，并将解析得到的接口表，封装成表格实体，得到文字形式的接口文档。两种方式都有相同的一些问题，例如：具有局限性，展示数据不完整，展示效果不好，交互方式不友好，也无法拓展新的功能。方式一生成的文档地址还会收到相关环境的ip与端口影响，前端开发人员会需要依据不同项目、不同环境打开不同的页面查看接口文档，并且无法提供对外输出所需的文档。方式二问题在于生成的表格形式的接口数据，不够直观，也没有能够在线调用接口调试的功能，功能较为单一。

当前技术条件下接口文档通常都是展示最新版本的接口，查看不同版本的接口信息改动需要开发人员手动打开不同版本接口文档进行人工比对。

一般一些对外的接口文档需要开发人员手动编写，相应的介绍与目录。

专利文献CN110941950A(申请号：CN201911179920.3)公开了接口文档的生成方法、装置、服务器及存储介质。该系统存在以下弊端：(1)此发明对数据处理略显复杂，且转换流程较多较为复杂。(2)此发明没有良好的拓展性，难以进行更多功能的定制开发，后续维护性较低。(3)只能得到静态的接口信息，无法在线调用调试。(4)无法输出markdown形式接口文档。(5)数据展示不友好，不直观且不支持新旧版本文档对比与展示。

发明内容

针对现有技术中的缺陷，本发明的目的是提供一种生成展示接口文档的系统、方法及介质。

根据本发明提供的生成展示接口文档的系统，包括：

数据解析模块：将全量数据依据数据之间的联系进行解析拆分，同时过滤掉预设范围内的重复数据；

数据展示模块：在界面编辑参数示例发送接口请求并展示相应数据；

文档导出模块：生成所需项目的接口文档并导出，导出的接口文档内容格式根据需求进行设置编辑。

优选的，不同项目数据形式不同，对应的解析方式也不同，根据项目类型进行解析；

同时展示新旧版本的接口相关数据信息，并进行数据对比。

优选的，通过接口请求得到全量项目列表后，通过对应项目名称发送请求获取到该项目的全量数据，通过遍历数据获取项目名称、项目版本、项目简介、项目部署的ip与端口以及项目包含的全量接口数据，通过遍历接口的数据将全量的接口名称与路径匹配到对应模块。

优选的，设置项目和接口数据的格式，分别与项目主页和接口数据展示页面进行绑定，通过解析出的数据中的模块数据在页面中展示对应的菜单，通过所选菜单跳转对应主页，通过点击菜单栏子项接口名跳转到对应接口详情页。

根据本发明提供的生成展示接口文档的方法，包括：

数据解析步骤：将全量数据依据数据之间的联系进行解析拆分，同时过滤掉预设范围内的重复数据；

数据展示步骤：在界面编辑参数示例发送接口请求并展示相应数据；