接口文档的生成方法、装置、计算机设备和存储介质

基本信息

申请号 CN202011110899.4 申请日 -
公开(公告)号 CN112230988A 公开(公告)日 2021-01-15
申请公布号 CN112230988A 申请公布日 2021-01-15
分类号 G06F8/73(2018.01)I 分类 计算;推算;计数;
发明人 杨文波 申请(专利权)人 蜂助手股份有限公司
代理机构 广州市智远创达专利代理有限公司 代理人 蜂助手股份有限公司
地址 510000广东省广州市天河区龙口横街28号南塔23楼自编2301-2341房
法律状态 -

摘要

摘要 本发明涉及一种接口文档的生成方法、装置、计算机设备和存储介质,所述方法包括:初始化接口代码;在项目对象模型文件中接入接口文档生成插件;在项目对象模型的配置文件中配置目标地址信息、类路径信息以及文件格式信息;采用接口文档生成插件扫描maven管理的项目源码并在项目源码中读取目标地址信息、类路径信息以及文件格式信息;根据目标地址信息以及类路径信息确定对应的目标代码接口,获取目标代码接口的接口名称、修饰符号、参数内容以及注释内容;根据文件格式信息以及目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成目标代码接口的接口文档。上述方法能够去除项目与接口文档生成装置的耦合性,降低项目风险与出现bug的几率。