[发明专利]一种API文档生成方法、装置、设备、存储介质在审

专利信息
申请号: 202211325371.8 申请日: 2022-10-27
公开(公告)号: CN115510880A 公开(公告)日: 2022-12-23
发明(设计)人: 凌利虎;吴迪;葛然;邹凌;马军明;吕蔚;张小磊 申请(专利权)人: 亿企赢网络科技有限公司
主分类号: G06F40/58 分类号: G06F40/58;G06F40/154
代理公司: 北京集佳知识产权代理有限公司 11227 代理人: 姚文杰
地址: 201203 上海市浦东新*** 国省代码: 上海;31
权利要求书: 查看更多 说明书: 查看更多
摘要:
搜索关键词: 一种 api 文档 生成 方法 装置 设备 存储 介质
【权利要求书】:

1.一种API文档生成方法,其特征在于,包括:

基于API文档生成请求获取需要生成API文档的Java文件;

对所述Java文件进行解析,以获取包含与Psi对象的名称和Psi对象的参数对应的英文字符串;

基于翻译策略对所述英文字符串进行中文翻译,以得到相应的翻译结果;

对所述翻译结果进行拼接,生成相应的API文档。

2.根据权利要求1所述的API文档生成方法,其特征在于,所述对所述Java文件进行解析,以获取包含与Psi对象的名称和Psi对象的参数对应的英文字符串,包括:

通过IDE接口将所述Java文件解析成Psi树结构;

从所述Psi树结构中获取Psi类,并获取所述Psi类的名称对应的英文字符串;

遍历所述Psi类中所有Psi属性和Psi方法,以获取对应的英文字符串。

3.根据权利要求2所述的API文档生成方法,其特征在于,所述遍历所述Psi类中所有Psi方法,以获取对应的英文字符串,包括:

遍历所有所述Psi方法,获取所述Psi方法的名称的英文字符串、所有参数的英文字符串和返回值类型的英文字符串。

4.根据权利要求3所述的API文档生成方法,其特征在于,所述基于翻译策略对所述英文字符串进行中文翻译,以得到相应的翻译结果,包括:

调用翻译接口功能并基于翻译策略对所述Psi方法的名称的英文字符串、所述参数的英文字符串和返回值类型的英文字符串进行中文翻译,以得到相应的翻译结果。

5.根据权利要求4所述的API文档生成方法,其特征在于,所述基于翻译策略对所述英文字符串进行中文翻译,以得到相应的翻译结果之前,还包括:

预先定义包含将英文字符串翻译为中文字符串的翻译方法的翻译接口类,并通过各种翻译服务实现翻译接口功能。

6.根据权利要求1至5任一项所述的API文档生成方法,其特征在于,所述基于翻译策略对所述英文字符串进行中文翻译,以得到相应的翻译结果之前,还包括:

基于翻译策略从服务列表中确定目标翻译服务,利用所述目标翻译服务对所述英文字符串进行中文翻译,以得到相应的翻译结果。

7.根据权利要求6所述的API文档生成方法,其特征在于,所述基于翻译策略对所述英文字符串进行中文翻译,以得到相应的翻译结果之前,还包括:

对所有翻译服务进行排序,并通过历史翻译情况对所述翻译服务进行权重分配,以得到包含所述翻译服务优先级的服务列表。

8.一种API文档生成装置,其特征在于,包括:

文件生成模块,用于基于API文档生成请求获取需要生成API文档的Java文件;

字符串获取模块,用于对所述Java文件进行解析,以获取包含与Psi对象的名称和Psi对象的参数对应的英文字符串;

翻译模块,用于基于翻译策略对所述英文字符串进行中文翻译,以得到相应的翻译结果;

结果拼接模块,用于对所述翻译结果进行拼接,生成相应的API文档。

9.一种电子设备,其特征在于,包括:

存储器,用于保存计算机程序;

处理器,用于执行所述计算机程序,以实现如权利要求1至7任一项所述的API文档生成方法的步骤。

10.一种计算机可读存储介质,其特征在于,用于存储计算机程序;其中,所述计算机程序被处理器执行时实现如权利要求1至7任一项所述的API文档生成方法的步骤。

下载完整专利技术内容需要扣除积分,VIP会员可以免费下载。

该专利技术资料仅供研究查看技术是否侵权等信息,商用须获得专利权人授权。该专利全部权利属于亿企赢网络科技有限公司,未经亿企赢网络科技有限公司许可,擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作,请联系【客服

本文链接:http://www.vipzhuanli.com/pat/books/202211325371.8/1.html,转载请声明来源钻瓜专利网。

×

专利文献下载

说明:

1、专利原文基于中国国家知识产权局专利说明书;

2、支持发明专利 、实用新型专利、外观设计专利(升级中);

3、专利数据每周两次同步更新,支持Adobe PDF格式;

4、内容包括专利技术的结构示意图流程工艺图技术构造图

5、已全新升级为极速版,下载速度显著提升!欢迎使用!

请您登陆后,进行下载,点击【登陆】 【注册】

关于我们 寻求报道 投稿须知 广告合作 版权声明 网站地图 友情链接 企业标识 联系我们

钻瓜专利网在线咨询

周一至周五 9:00-18:00

咨询在线客服咨询在线客服
tel code back_top