[发明专利]API文档的生成方法与装置、存储介质及计算机设备在审
| 申请号： | 201910688147.7 | 申请日： | 2019-07-29 |
| 公开（公告）号： | CN110471698A | 公开（公告）日： | 2019-11-19 |
| 发明（设计）人： | 黄兴鲁 | 申请（专利权）人： | 深圳数位传媒科技有限公司 |
| 主分类号： | G06F8/73 | 分类号： | G06F8/73;G06F16/178 |
| 代理公司： | 44395 广东良马律师事务所 | 代理人： | 李良<国际申请>=<国际公布>=<进入国 |
| 地址： | 518000 广东省深圳市南山区*** | 国省代码： | 广东;44 |
| 权利要求书： | 查看更多 | 说明书： | 查看更多 |
| 摘要： | |||
| 搜索关键词： | 文档 目标代码 同步脚本 文档描述 计算机设备 存储介质 开发过程 实际功能 同步更新 更新 维护 管理 开发 | ||
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文档的生成方法，其特征在于，所述同步脚本被执行后用于调用swagger扫描所述所述目标代码注释，生成所述目标API代码对应的所述目标API文档，并将所述目标API文档上传至所述API文档管理平台进行存储；其中，所述Swagger为开源的API定义协议。
7.根据权利要求1所述的API文档的生成方法，其特征在于，所述获取开发者编写的目标API代码、所述目标API代码对应的目标代码注释和同步脚本，包括：
向目标代码数据库发送数据请求信息，所述数据请求信息包括要求所述目标代码数据库返回开发者编写的所述目标API代码、所述目标代码注释和所述同步脚本的信息；
接收所述目标代码数据库返回的开发者编写的所述目标API代码、所述目标代码注释和所述同步脚本。
8.一种的API文档的生成装置，其特征在于，包括：
获取模块，用于获取开发者编写的目标API代码、所述目标API代码对应的目标代码注释和同步脚本；
生成模块，用于根据所述目标代码注释和所述同步脚本，生成所述目标API代码对应的目标API文档；
其中，所述目标API代码、所述目标代码注释和所述同步脚本由开发者完成编写并存储于目标代码数据库。
9.一种存储介质，其特征在于，其上存储有计算机程序，所述计算机程序被执行时实现权利要求1～7任一项所述的API文档的生成方法。
10.一种计算机设备，其特征在于，其包括处理器、存储器及存储于所述存储器上并可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现权利要求1～7任一项所述的API文档的生成方法。
该专利技术资料仅供研究查看技术是否侵权等信息，商用须获得专利权人授权。该专利全部权利属于深圳数位传媒科技有限公司，未经深圳数位传媒科技有限公司许可，擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作，请联系【客服】
本文链接：http://www.vipzhuanli.com/pat/books/201910688147.7/1.html，转载请声明来源钻瓜专利网。
- 上一篇：配置方法及相关产品
- 下一篇：用于指令处理的处理器核、方法和系统
