[发明专利]API文档的生成方法与装置、存储介质及计算机设备

说明书

本发明公开了一种API文档的生成方法与装置、存储介质及计算机设备，其中该API文档的生成方法包括：获取开发者编写的目标API代码、所述目标API代码对应的目标代码注释和同步脚本；根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档。本发明解决了现有技术中的以下问题：由于API文档和其对应的代码是分开的，API文档的管理需要有人专门去维护，但是在开发过程中，我们需要经常修改API的定义，要求API文档要同步更新，而我们经常忘记更新API文档，导致API文档描述不符合现有API的定义，API文档描述落后于当前API的实际功能。

技术领域

本发明涉及WEB应用开发技术领域，特别是涉及一种API文档的生成方法与装置、存储介质及计算机设备。

背景技术

API(Application Programming Interface，应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。现有API文档管理办法为：开发者自己创建API文档，编写API定义和参数等信息。现有技术的具体实施办法为：1、创建word文档文件；2、编写API定义，包括项目名称，API的描述，API的url地址，API的参数和API的响应值等；3、存储word文档。另外，也有很多API管理平台，例如小幺鸡等，通过在平台填写API描述，填写API参数和响应值，最终生成一份API文档。现有技术的这种API文档管理办法的缺点是，需要有人专门去维护API文档信息，因为API文档和其对应的代码是分开的。但是，在开发过程中，我们需要经常修改API的定义，这就必须要求API文档要同步更新，而我们经常忘记更新API文档，导致API文档描述不符合现有API的定义，API文档描述落后于当前API的实际功能。

发明内容

本发明实施例提供一种API文档的生成方法与装置、存储介质及计算机设备，以解决现有技术中的以下问题：由于API文档和其对应的代码是分开的，API文档的管理需要有人专门去维护，但是在开发过程中，我们需要经常修改API的定义，要求API文档要同步更新，而我们经常忘记更新API文档，导致API文档描述不符合现有API的定义，API文档描述落后于当前API的实际功能。

为解决上述技术问题，本发明实施例采用的第一技术方案如下：

一种API文档的生成方法，其包括：获取开发者编写的目标API代码、所述目标API代码对应的目标代码注释和同步脚本；根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档；其中，所述目标API代码、所述目标代码注释和所述同步脚本由开发者完成编写并存储于目标代码数据库。

可选地，所述根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档之后，包括：将所述目标API文档导入API文档管理平台进行存储。

可选地，所述根据所述目标代码注释和所述同步脚本，生成对应的目标API文档，包括：执行所述同步脚本，通过Swagger扫描所述目标代码注释，生成对应的所述目标API文档；其中，所述Swagger为开源的API定义协议。

可选地，所述将所述目标API文档导入API文档管理平台进行存储，包括：执行所述同步脚本，将所述目标API文档上传至所述文档管理平台进行存储。

可选地，所述执行所述同步脚本，包括：触发jenkins任务，由jenkins执行所述同步脚本；其中，所述jenkins为可实现任务调度的平台。

可选地，所述同步脚本被执行后用于调用swagger扫描所述所述目标代码注释，生成所述目标API代码对应的所述目标API文档，并将所述目标API文档上传至所述API文档管理平台进行存储；其中，所述Swagger为开源的API定义协议。