API文档的生成方法与装置、存储介质及计算机设备制造方法及图纸

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

API document generation method and device, storage medium and computer equipment

The invention discloses an API document generation method and device, storage medium and computer equipment, wherein the API document generation method includes: obtaining the target api code written by the developer, the target code annotation and synchronization script corresponding to the target api code; generating the target API document corresponding to the target api code according to the target code annotation and synchronization script \u3002 The invention solves the following problems in the prior art: because the API document and its corresponding code are separated, the management of the API document needs to be specially maintained by someone, but in the development process, we need to frequently modify the definition of the API, require the API document to be updated synchronously, and we often forget to update the API document, resulting in that the description of the API document does not conform to the definition of the existing API, API document Describes the actual functionality behind the current API.

【技术实现步骤摘要】
API文档的生成方法与装置、存储介质及计算机设备
本专利技术涉及WEB应用开发
，特别是涉及一种API文档的生成方法与装置、存储介质及计算机设备。
技术介绍
API(ApplicationProgrammingInterface，应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。现有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定义协议。可选地，所述获取开发者编写的目标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的实际功能。附图说明图1是本专利技术实施例一的API文档的生成方法一实施方式的实施流程图；图2是本专利技术实施例二的API文档的生成装置一实施方式的部分结构框架图；图3是本专利技术实施例三的存储介质一实施方式的部分结构框架图；图4是本专利技术实施例四的计算机设备一实施方式的部分结构框架图。具体实施方式实施例一请参阅图1，图1是本专利技术实施例的API文档的生成方法的实施流程图。结合图2可以得到，本专利技术实施例的API文档的生成方法，包括以下步骤：步骤S101：获取开发者编写的目标API代码、所述目标API代码对应的目标代码注释和同步脚本。其中，同步脚本是一种可以被执行的程序。步骤S102：根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档。其中，所述目标API代码、所述目标代码注释和所述同步脚本由开发者完成编写并存储于目标代码数据库。在本实施例中，可选地，所述根据所述目标代码注释和所述同步脚本，生成对应的目标API文档，包括：执行所述同步脚本，通过Swagger扫描所述目标代码注释，生成对应的所述目标API文档；其中，所述Swagger为开源的API定义协议。在本实施例中，可选地，所述根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档之后，包括：将所述目标API文档导入API文档管理平台进行存储。在本实施例中，可选地，所述将所述目标API文档导入API文档管理平台进行存储，包括：执行所述同步脚本，将所述目标API文档上传至所述文档管理平台进行存储。在本实施例中，可选地，所述执行所述同步脚本，包括：触发jenkins任务，由jenkins执行所述同步脚本。其中，所述j本文档来自技高网...

【技术保护点】
1.一种API文档的生成方法，其特征在于，包括：/n获取开发者编写的目标API代码、所述目标API代码对应的目标代码注释和同步脚本；/n根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档；/n其中，所述目标API代码、所述目标代码注释和所述同步脚本由开发者完成编写并存储于目标代码数据库。/n

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


2.根据权利要求1所述的API文档的生成方法，其特征在于，所述根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档之后，包括：
将所述目标API文档导入API文档管理平台进行存储。


3.根据权利要求1所述的API文档的生成方法，其特征在于，所述根据所述目标代码注释和所述同步脚本，生成对应的目标API文档，包括：
执行所述同步脚本，通过Swagger扫描所述目标代码注释，生成对应的所述目标API文档；其中，所述Swagger为开源的API定义协议。


4.根据权利要求2所述的API文档的生成方法，其特征在于，所述将所述目标API文档导入API文档管理平台进行存储，包括：
执行所述同步脚本，将所述目标API文档上传至所述文档管理平台进行存储。


5.根据权利要求3或4所述的API文档的生成方法，其特征在于，所述执行所述同步脚本，包括：
触发jenkins任务，由jenkins执行所述同步脚本；其中，所述jenkins为可实现任务调度的平台。


6.根据权利要求1所述的API文档的生成方法，其特征在于，所述...

【专利技术属性】
技术研发人员：黄兴鲁，
申请(专利权)人：深圳数位传媒科技有限公司，
类型：发明
国别省市：广东;44