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

(19)中华人民共和国国家知识产权局(12)发明专利申请(10)申请公布号CN112230988A(43)申请公布日2021.01.15(21)申请号202011110899.4(22)申请日2020.10.16(71)申请人蜂助手股份有限公司地址510000广东省广州市天河区龙口横街28号南塔23楼自编2301-2341房(72)发明人杨文波(74)专利代理机构广州市智远创达专利代理有限公司44619代理人王会龙(51)Int.Cl.G06F8/73(2018.01)G06F8/41(2018.01)G06F9/445(2018.01)权利要求书2页说明书8页附图3页(54)发明名称接口文档的生成方法、装置、计算机设备和存储介质(57)摘要本发明涉及一种接口文档的生成方法、装置、计算机设备和存储介质，所述方法包括：初始化接口代码；在项目对象模型文件中接入接口文档生成插件；在项目对象模型的配置文件中配置目标地址信息、类路径信息以及文件格式信息；采用接口文档生成插件扫描maven管理的项目源码并在项目源码中读取目标地址信息、类路径信息以及文件格式信息；根据目标地址信息以及类路径信息确定对应的目标代码接口，获取目标代码接口的接口名称、修饰符号、参数内容以及注释内容；根据文件格式信息以及目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成目标代码接口的接口文档。上述方法能够去除项目与接口文档生成装置的耦合性，降低项目风险与出现bug的几率。CN112230988ACN112230988A权利要求书1/2页1.一种接口文档的生成方法，其特征在于，所述方法包括：在集成开发环境IDE的编辑器中初始化接口代码；在maven的项目对象模型文件中接入接口文档生成插件，所述接口文档生成插件为maven插件；在所述项目对象模型的配置文件中配置生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息；启动所述接口文档生成插件，采用所述接口文档生成插件扫描maven管理的项目源码并在所述项目源码中读取所述目标地址信息、所述类路径信息以及所述文件格式信息；采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容；采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档。2.根据权利要求1所述的方法，其特征在于，所述文件格式信息包括排版格式，所述根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档，包括：按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。3.根据权利要求2所述的方法，其特征在于，所述方法还包括：确定所述目标代码接口的接口文档的文档语言；所述按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档，包括：将所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容转换为所述文档语言的接口名称、修饰符号、参数内容以及注释内容；按照所述排版格式对所述文档语言的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。4.根据权利要求1所述的方法，其特征在于，所述根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口之后，包括：根据预设的接口名称定义规范判断所述目标代码接口的统一资源定位符是否符合预设要求；若是，执行所述获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容的步骤。5.根据权利要求1所述的方法，其特征在于，所述在maven的项目对象模型文件中接入接口文档生成插件之前，还包括：确定一个或多个接口的接口定义规范信息；根据所述接口定义规范信息生成所述接口文档生成插件。6.根据权利要求1所述的方法，其特征在于，所述采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档之后，还包括：若检测到采用所述接口文档生成插件生成所述目标代码接口的接口文档失败，使用集2CN112230988A权利要求书2/2页成开发环境插件生成所述目标代码接口的接口文档。7.根据权利要求1所述的方法，其特征在于，所述采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，包括：采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息生成所述目标代码接口的类和方法；根据生成的所述目标代码接口的类和方法确定所述目标代码接口。8.一种接口