一种API接口文档生成方法、系统、设备和可读存储介质与流程

本发明涉及计算机，具体涉及一种api接口文档生成方法、系统、设备和可读存储介质。

背景技术：

1、随着web技术的发展，前后端分离成为越来越多互联网公司构建应用的方式。由于前端的客户端和后端的服务端一般由不同的开发人员开发，因此服务端需要通过开发人员定义的api(application programming interface，应用程序编程接口)对外提供服务，客户端则需要根据api提供的功能进行对接开发，因此用于描述服务端api功能的api文档必不可少。

2、由于接口方式多样化，后台管理功能都是人工线下编辑生成静态html挂到开放平台上，或者由在线markdown文档编辑，由前台渲染实现在线管理。当前的api文档往往需要开发人员根据api的结构进行单独的编写，因此会产生一定的人工成本，并且开发人员对于api文档的主观编写也难以确保api文档的准确性。

技术实现思路

1、基于此，本申请实施例提供一种api接口文档生成方法、系统、设备和可读存储介质，在api接口调用的过程中降低产生api文档过程所需的人工成本，并保证所生成的api文档的准确性，实现高效准确的api调用。

2、为了实现上述目的，本申请实施例提供如下技术方案：

3、根据本申请实施例的第一方面，提供了一种api接口文档生成方法，所述方法包括：

4、接收目标api接口调用请求；所述目标api接口调用请求携带文档详情；

5、根据所述目标api接口调用请求调用程序接口查询是否有对应的api接口文档模型；

6、若有，则根据所述文档详情和所述api接口文档模型生成目标api开发文档；若没有，则根据所述目标api接口调用请求新建目标api开发文档；

7、将所述目标api开发文档返回并调用。

8、可选地，根据所述目标api接口调用请求调用程序接口查询是否有对应的api接口文档模型，包括：

9、根据所述目标api接口调用请求获取目标api接口源代码；

10、将所述目标api接口源代码加载至集成开发环境；

11、调用所述集成开发环境的程序接口对所述目标api接口源代码进行解析，得到api文档对象树；

12、根据所述api文档对象树查询是否有对应的api接口文档模型。

13、可选地，所述api文档对象树包括文档目录信息、文档字段参数、文档组件信息和返回参数。

14、可选地，所述根据所述api文档对象树查询是否有对应的api接口文档模型，包括：

15、根据所述api文档对象树中文档参数之间的结构关系查询数据库中是否有所述结构关系对应的api接口文档模型。

16、可选地，根据所述文档详情和所述api接口文档模型生成目标api开发文档，包括：

17、基于所述目标api接口将所述文档详情写入所述api接口文档模型，生成所述目标api开发文档。

18、可选地，在所述接收目标api接口调用请求之后，所述方法还包括：

19、对所述目标api接口调用请求进行安全及身份认证，若所述目标api接口调用请求认证合法，则执行下一步。

20、可选地，所述方法还包括：

21、将所述目标api接口调用请求对应的目标api开发文档存储至数据库中；

22、将所述目标api开发文档编译成web可视化文档发布给开发端。

23、根据本申请实施例的第二方面，提供了一种api接口文档生成系统，所述系统包括：

24、调用请求接收模块，用于接收目标api接口调用请求；所述目标api接口调用请求携带文档详情；

25、模型查询模块，用于根据所述目标api接口调用请求调用程序接口查询是否有对应的api接口文档模型；

26、api开发文档生成模块，用于若有，则根据所述文档详情和所述api接口文档模型生成目标api开发文档；若没有，则根据所述目标api接口调用请求新建目标api开发文档；

27、文档返回模块，用于将所述目标api开发文档返回并调用。

28、可选地，模型查询模块，具体用于：

29、根据所述目标api接口调用请求获取目标api接口源代码；

30、将所述目标api接口源代码加载至集成开发环境；

31、调用所述集成开发环境的程序接口对所述目标api接口源代码进行解析，得到api文档对象树；

32、根据所述api文档对象树查询是否有对应的api接口文档模型。

33、可选地，所述api文档对象树包括文档目录信息、文档字段参数、文档组件信息和返回参数。

34、可选地，所述根据所述api文档对象树查询是否有对应的api接口文档模型，包括：

35、根据所述api文档对象树中文档参数之间的结构关系查询数据库中是否有所述结构关系对应的api接口文档模型。

36、可选地，api开发文档生成模块，用于：基于所述目标api接口将所述文档详情写入所述api接口文档模型，生成所述目标api开发文档。

37、可选地，所述系统还包括：

38、验证模块，用于对所述目标api接口调用请求进行安全及身份认证，若所述目标api接口调用请求认证合法，则执行下一步。

39、可选地，所述系统还包括：

40、存储模块，用于将所述目标api接口调用请求对应的目标api开发文档存储至数据库中；将所述目标api开发文档编译成web可视化文档发布给开发端。

41、根据本申请实施例的第三方面，提供了一种电子设备，包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，所述处理器运行所述计算机程序时执行以实现上述第一方面所述的方法。

42、根据本申请实施例的第四方面，提供了一种计算机可读存储介质，其上存储有计算机可读指令，所述计算机可读指令可被处理器执行以实现上述第一方面所述的方法。

43、综上所述，本申请实施例提供了一种api接口文档生成方法、系统、设备和可读存储介质，通过接收目标api接口调用请求；所述目标api接口调用请求携带文档详情；根据所述目标api接口调用请求调用程序接口查询是否有对应的api接口文档模型；若有，则根据所述文档详情和所述api接口文档模型生成目标api开发文档；若没有，则根据所述目标api接口调用请求新建目标api开发文档；将所述目标api开发文档返回并调用。在api接口调用的过程中降低产生api文档过程所需的人工成本，并保证所生成的api文档的准确性，实现高效准确的api调用。

技术特征：

1.一种api接口文档生成方法，其特征在于，所述方法包括：

2.如权利要求1所述的方法，其特征在于，根据所述目标api接口调用请求调用程序接口查询是否有对应的api接口文档模型，包括：

3.如权利要求2所述的方法，其特征在于，所述api文档对象树包括文档目录信息、文档字段参数、文档组件信息和返回参数。

4.如权利要求2所述的方法，其特征在于，所述根据所述api文档对象树查询是否有对应的api接口文档模型，包括：

5.如权利要求1所述的方法，其特征在于，根据所述文档详情和所述api接口文档模型生成目标api开发文档，包括：

6.如权利要求1所述的方法，其特征在于，在所述接收目标api接口调用请求之后，所述方法还包括：

7.如权利要求1所述的方法，其特征在于，所述方法还包括：

8.一种api接口文档生成系统，其特征在于，所述系统包括：

9.一种电子设备，包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，其特征在于，所述处理器运行所述计算机程序时执行以实现如权利要求1-7任一项所述的方法。

10.一种计算机可读存储介质，其特征在于，其上存储有计算机可读指令，所述计算机可读指令可被处理器执行以实现如权利要求1-7任一项所述的方法。

技术总结本发明涉及一种API接口文档生成方法、系统、设备和可读存储介质，所述方法包括：接收目标API接口调用请求；所述目标API接口调用请求携带文档详情；根据所述目标API接口调用请求调用程序接口查询是否有对应的API接口文档模型；若有，则根据所述文档详情和所述API接口文档模型生成目标API开发文档；若没有，则根据所述目标API接口调用请求新建目标API开发文档；将所述目标API开发文档返回并调用。在API接口调用的过程中降低产生API文档过程所需的人工成本，并保证所生成的API文档的准确性，实现高效准确的API调用。技术研发人员：王立君受保护的技术使用者：平安壹钱包电子商务有限公司技术研发日：技术公布日：2024/8/20