【技术实现步骤摘要】
本专利技术涉及数据处理，尤其是涉及一种接口wiki文档自动化生成方法、设备及介质。
技术介绍
1、传统方式下服务接口文档是由人工手动编写，按照接口定义，人工提取接口信息，人工梳理数据关系，然后根据接口定义信息，一个一个字段提取出来写在文档上面。每个字段都需要在文档中注明字段名称、字段类型、字段是否可以为空、字段的默认值、字段的示例值、字段的描述等。另外字段有基本数据类型和复杂结构体之分，复杂结构体可能有多层嵌套，深度可能多达数层。接口文档还需要包含每个接口的错误码。当接口数量较多时，这种纯机械式手工服务文档编写效率低下且容易出错，准确性无法保证。
2、为提高文档生成效率、降低出错率，接口文档自动化生成技术出现。例如，专利申请cn110955416a提出了一种接口文档生成方法、装置、设备和计算机存储介质，该方法解决当前接口文档需要开发人员手动编写，接口文档编写效率低，导致软件开发周期较长的技术问题。但是随着频繁的交互通信，为后期的维护阶段带来较大的难题，现有技术中，有通过登录wiki平台进行攥写和更新，但是在wiki平台上维护接口文档信息时，存在以下缺点：1、一个项目涉及的接口量可达数万个，期初维护数据困难，工作量大；2、后续维护更新不及时，效率低下；3、长此以往，就会导致接口文档信息不是最新最全的，失去了知识库的意义。
3、因此，降低维护难度、提高更新速度成为亟需解决的重点和难点。
技术实现思路
1、本专利技术的目的就是为了提供一种提高维护效率的接口wiki
2、本专利技术的目的可以通过以下技术方案来实现：
3、一种接口wiki文档自动化生成方法，包括以下步骤：
4、在wiki平台的数据库中创建wiki-项目配置表和wiki-接口信息表；
5、通过devops发布，调用java服务器，获取wiki-项目配置表中的基础数据和wiki-接口信息表中的所有接口信息；
6、基于java的页面模板引擎，编写wiki页面内容框架；
7、将所述所有接口信息转换为java对象，得到以接口集合为key1、接口出入参数为value1的接口信息集合；
8、获取wiki-接口信息表中的接口路径信息，得到接口路径集合为key2、对应路径参数集合为value2的wiki_接口路径集合；
9、循环遍历map中每个接口信息，填充至所述的wiki页面内容框架中，生成每个接口对应的wiki_content文档；
10、将所述接口信息集合中接口key1作为wiki_接口路径集合中key2，获取对应的value3，判断value3是否为空，若是，则wiki_content文档为新增文档，若否，则wiki_content文档为已有文档；
11、基于所述新增文档或已有文档，生成最终的接口wiki文档并对所述wiki-接口信息表和wiki_接口路径集合进行更新处理，直至循环结束，得到每个接口对应的接口wiki文档。
12、进一步地，所述wiki-项目配置表的字段包括项目模块名、swagger路径、wiki父级标识符、wiki账号、wiki密码和wiki根目录。
13、进一步地，所述wiki-接口信息表的字段包括接口路径、项目模块名、wiki唯一标识、哈希值和wiki父级标识符。
14、进一步地，所述接口信息以json格式进行表示。
15、进一步地，所述页面模板引擎为velocity。
16、进一步地，基于所述新增文档，生成最终的接口wiki文档以及更新wiki-接口信息表和wiki_接口路径集合的具体步骤包括：
17、调用wiki的restful服务，将wiki_content文档生成为接口wiki文档；
18、将key1、wiki_content文档的哈希值和wiki父级标识符存于wiki-接口信息表中，同时将key1从wiki_接口路径集合中删除。
19、进一步地，基于所述已有文档，生成最终的接口wiki文档以及更新wiki-接口信息表和wiki_接口路径集合的具体步骤包括：
20、判断所述wiki_content文档的哈希值是否与wiki-接口信息表的哈希值相等，若是，则基于已有文档获取对应的已有的接口wiki文档，并将key1从所述wiki_接口路径集合中删除，若否，则调用wiki的restful服务生成接口wiki文档，并更新wiki-接口信息表的哈希值，同时将key1从wiki_接口路径集合中删除。
21、进一步地，还包括：map循环结束时，判断wiki_接口路径集合中是否还有数据，若有，则删除对应的wiki_content文档以及对应的wiki-接口信息表中的数据，若否，则不做任何操作。
22、本专利技术还提供一种电子设备，包括：一个或多个处理器；存储器；和被存储在存储器中的一个或多个程序，所述一个或多个程序包括用于执行如上所述接口wiki文档自动化生成方法的指令。
23、本专利技术还提供一种计算机可读存储介质，包括供电子设备的一个或多个处理器执行的一个或多个程序，所述一个或多个程序包括用于执行如上所述接口wiki文档自动化生成方法的指令。
24、与现有技术相比，本专利技术具有以下有益效果：
25、(1)本专利技术在根据接口信息生成接口wiki文档过程中，通过判断是否为已有文档和新增文档，分别对接口信息表进行不同程度地更新，接口信息表是最新最全的，维护效率会显著提高。
26、(2)本专利技术能够及时根据不断地迭代过程通过增删改操作不断地更新wiki-接口信息表，可以达到按迭代频率进行接口wiki文档的更新，保证接口wiki文档是最新的，具有较强的时效性。
27、(3)本专利技术通过自动更新信息表，针对接口量较大的项目，可以有效地完成期初数据的维护，可快速地在页面创建接口wiki文档，同时也解决了手工维护困难、任务量大和效率低的问题。
本文档来自技高网...【技术保护点】
1.一种接口wiki文档自动化生成方法，其特征在于，包括以下步骤：
2.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，所述wiki-项目配置表的字段包括项目模块名、swagger路径、wiki父级标识符、wiki账号、wiki密码和wiki根目录。
3.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，所述wiki-接口信息表的字段包括接口路径、项目模块名、wiki唯一标识、哈希值和wiki父级标识符。
4.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，所述接口信息以json格式进行表示。
5.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，所述页面模板引擎为velocity。
6.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，基于所述新增文档，生成最终的接口wiki文档以及更新wiki-接口信息表和wiki_接口路径集合的具体步骤包括：
7.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在
8.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，还包括：map循环结束时，判断wiki_接口路径集合中是否还有数据，若有，则删除对应的wiki_content文档以及对应的wiki-接口信息表中的数据，若否，则不做任何操作。
9.一种电子设备，其特征在于，包括：
10.一种计算机可读存储介质，其特征在于，包括供电子设备的一个或多个处理器执行的一个或多个程序，所述一个或多个程序包括用于执行如权利要求1-8任一所述接口wiki文档自动化生成方法的指令。
...【技术特征摘要】
1.一种接口wiki文档自动化生成方法，其特征在于，包括以下步骤：
2.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，所述wiki-项目配置表的字段包括项目模块名、swagger路径、wiki父级标识符、wiki账号、wiki密码和wiki根目录。
3.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，所述wiki-接口信息表的字段包括接口路径、项目模块名、wiki唯一标识、哈希值和wiki父级标识符。
4.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，所述接口信息以json格式进行表示。
5.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，所述页面模板引擎为velocity。
6.根据权利要求1所述的一种接口wiki文档自动化生成方法，其特征在于，基于所述新增...
【专利技术属性】
技术研发人员：陈丽禅，徐稀，高晓国，
申请(专利权)人：欧冶云商股份有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。