基于接口文档的代码生成方法、装置、存储介质及服务器.pdf

(19)中华人民共和国国家知识产权局(12)发明专利申请(10)申请公布号CN112230904A(43)申请公布日2021.01.15(21)申请号202011112422.X(22)申请日2020.10.16(71)申请人蜂助手股份有限公司地址510000广东省广州市天河区龙口横街28号南塔23楼自编2301-2341房(72)发明人周远杨文波(74)专利代理机构广州市智远创达专利代理有限公司44619代理人王会龙(51)Int.Cl.G06F8/30(2018.01)G06F8/41(2018.01)G06F9/445(2018.01)权利要求书2页说明书8页附图3页(54)发明名称基于接口文档的代码生成方法、装置、存储介质及服务器(57)摘要本发明公开了一种基于接口文档的代码生成方法、装置、存储介质及服务器；其中，所述方法包括：在软件项目中配置接口文档代码生成插件，所述接口文档代码生成插件为maven插件；配置接口文档的路径配置文件，所述路径配置文件用于指示接口文档地址；利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，得到所述接口文档的接口文档地址；利用所述接口文档代码生成插件根据所述接口文档地址确定所述接口文档并获取所述接口文档的内容，根据所述接口文档的内容生成接口代码。上述方法能够自动化根据接口文档生成接口代码，无需人工手动操作，可降低接口代码的出错概率，并可提升接口代码的生成效率。CN112230904ACN112230904A权利要求书1/2页1.一种基于接口文档的代码生成方法，其特征在于，所述方法包括：在软件项目中配置接口文档代码生成插件，所述接口文档代码生成插件为maven插件；配置接口文档的路径配置文件，所述路径配置文件用于指示接口文档地址；利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，得到所述接口文档的接口文档地址；利用所述接口文档代码生成插件根据所述接口文档地址确定所述接口文档并获取所述接口文档的内容，根据所述接口文档的内容生成接口代码。2.根据权利要求1所述的代码生成方法，其特征在于，所述接口文档的内容包括接口名称、修饰符号、参数内容、注释内容。3.根据权利要求2所述的代码生成方法，其特征在于，所述根据所述接口文档的内容生成接口代码，包括：确定所述接口代码的格式布局以及所述接口代码的生成文档；根据所述格式布局获取所述接口名称对应在所述生成文档中的第一位置，根据所述接口名称在所述第一位置生成所述接口名称的代码；根据所述格式布局获取所述修饰符号对应在所述生成文档中的第二位置，根据所述修饰符号在所述第二位置生成所述修饰符号的代码；根据所述格式布局获取所述参数内容对应在所述生成文档中的第三位置，根据所述参数内容在所述第三位置生成所述参数内容的代码；根据所述格式布局获取所述注释内容对应在所述生成文档中的第四位置，根据所述注释内容在所述第四位置生成所述注释内容的代码；根据所述接口名称的代码、所述修饰符号的代码、所述参数内容的代码以及所述注释内容的代码得到所述接口代码。4.根据权利要求1所述的代码生成方法，其特征在于，所述方法还包括：确定maven项目对象模型中所述软件项目的每个构建步骤；根据所述每个构建步骤生成所述接口文档代码生成插件。5.根据权利要求4所述的代码生成方法，其特征在于，所述接口文档代码生成插件为聚合的Java类文件、相关的元数据、文本、图片的Jar数据包，并且所述接口文档代码生成插件用于实现maven插件的接口。6.根据权利要求5所述的代码生成方法，其特征在于，所述利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，包括：在pom文件的build标签里引用所述接口文档代码生成插件，以利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件。7.根据权利要求6所述的代码生成方法，其特征在于，所述根据所述接口文档的内容生成接口代码之后，还包括：运行所述接口代码，得到所述接口代码的运行结果；根据所述运行结果确定所述接口代码中的错误代码；根据所述错误代码确定所述接口文档中的错误内容；根据所述错误内容修改所述接口文档。8.一种基于接口文档的代码生成装置，其特征在于，所述装置包括：2CN112230904A权利要求书2/2页第一配置模块：用于在软件项目中配置接口文档代码生成插件，所述接口文档代码生成插件为maven插件；第二配置模块：用于配置接口文档的路径配置文件，所述路径配置文件用于指示接口文档地址；解析模块：用于利用所述接口文档代码生成插件的配置解析器解析所述路径配置文件，得到所述接口文档的接口文档地址；生成模块：用于利用所述接口文档代码生成插件根据所述接口文档地址确定所述接口文档并获取所述接口文档的内容，根据所述接口文档的内容生成接口代码。9.一种计算机可读