[发明专利]接口文档的生成方法、装置、电子设备及存储介质在审
申请号: | 202010618453.6 | 申请日: | 2020-06-30 |
公开(公告)号: | CN111880778A | 公开(公告)日: | 2020-11-03 |
发明(设计)人: | 刘涛;杨小澎;王刚;李奇原 | 申请(专利权)人: | 百度在线网络技术(北京)有限公司 |
主分类号: | G06F8/30 | 分类号: | G06F8/30;G06F8/41;G06F8/65 |
代理公司: | 北京鸿德海业知识产权代理事务所(普通合伙) 11412 | 代理人: | 田宏宾 |
地址: | 100085 北京*** | 国省代码: | 北京;11 |
权利要求书: | 查看更多 | 说明书: | 查看更多 |
摘要: | |||
搜索关键词: | 接口 文档 生成 方法 装置 电子设备 存储 介质 | ||
1.一种接口文档的生成方法,其中,所述方法包括:
从仓库中下载应用程序接口资源包;
对所述应用程序接口资源包进行解析,获取接口文档的元信息;
基于所述接口文档的元信息,生成所述接口文档。
2.根据权利要求1所述的方法,其中,对所述应用程序接口资源包进行解析,获取接口文档的元信息,包括:
对所述应用程序接口资源包进行解析,获取方法分类集合的信息;
对所述应用程序接口资源包进行解析,获取所述方法分类集合中的方法的信息;
对所述应用程序接口资源包进行解析,获取所述方法中的参数信息。
3.根据权利要求2所述的方法,其中,对所述应用程序接口资源包进行解析,获取方法分类集的信息,包括:
基于预设的方法分类集合的埋点信息,对所述应用程序接口资源包进行解析,获取所述方法分类集合的信息;
对所述应用程序接口资源包进行解析,获取所述方法分类集合中的方法的信息,包括:
基于预设的方法的埋点信息,对所述应用程序接口资源包进行解析,获取所述方法分类集合中的方法的信息;
对所述应用程序接口资源包进行解析,获取所述方法中的参数信息,包括:
对所述应用程序接口资源包进行解析,获取所述方法中的请求类型和返回类型的信息;
将所述请求类型的信息和所述返回类型的信息,分别作为实体进行进一步解析,并基于预设的参数的属性的埋点信息,获取所述方法中的请求类型和返回类型中的参数的属性信息以及所述属性信息中包括的参数的属性信息。
4.一种应用程序接口资源包的处理方法,其中,所述方法包括:
获取开发的应用程序接口资源包;
在所述应用程序接口资源包中设置埋点信息;
向仓库上传设置了所述埋点信息的所述应用程序接口资源包,以供接口文档生成装置下载所述应用程序接口资源包;基于设置的所述埋点信息对所述应用程序接口资源包进行解析,获取接口文档的元信息;并基于所述接口文档的元信息,生成所述接口文档。
5.根据权利要求4所述的方法,其中,在所述应用程序接口资源包中设置埋点信息,包括:
在所述应用程序接口资源包中设置方法分类集合的埋点信息、所述方法分类集合中的方法的埋点信息、以及所述方法中的参数的属性的埋点信息。
6.一种接口文档的生成装置,其中,所述装置包括:
下载模块,用于从仓库中下载应用程序接口资源包;
解析模块,用于对所述应用程序接口资源包进行解析,获取接口文档的元信息;
生成模块,用于基于所述接口文档的元信息,生成所述接口文档。
7.根据权利要求6所述的装置,其中,所述解析模块,包括:
第一解析单元,用于对所述应用程序接口资源包进行解析,获取方法分类集合的信息;
第二解析单元,用于对所述应用程序接口资源包进行解析,获取所述方法分类集合中的方法的信息;
第三解析单元,用于对所述应用程序接口资源包进行解析,获取所述方法中的参数信息。
8.根据权利要求7所述的装置,其中:
所述第一解析单元,用于基于预设的方法分类集合的埋点信息,对所述应用程序接口资源包进行解析,获取所述方法分类集合的信息;
所述第二解析单元,用于基于预设的方法的埋点信息,对所述应用程序接口资源包进行解析,获取所述方法分类集合中的方法的信息;
所述第三解析单元,用于:
对所述应用程序接口资源包进行解析,获取所述方法中的请求类型和返回类型的信息;
将所述请求类型的信息和所述返回类型的信息,分别作为实体进行进一步解析,并基于预设的参数的属性的埋点信息,获取所述方法中的请求类型和返回类型中的参数的属性信息以及所述属性信息中包括的参数的属性信息。
该专利技术资料仅供研究查看技术是否侵权等信息,商用须获得专利权人授权。该专利全部权利属于百度在线网络技术(北京)有限公司,未经百度在线网络技术(北京)有限公司许可,擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作,请联系【客服】
本文链接:http://www.vipzhuanli.com/pat/books/202010618453.6/1.html,转载请声明来源钻瓜专利网。