[发明专利]接口文档的生成方法、装置、计算机设备和存储介质

说明书

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

技术领域

本发明涉及接口处理技术领域，特别是涉及一种接口文档的生成方法、装置、计算机设备和存储介质。

背景技术

传统生成接口文档的技术中，需要引入第三方所需jar(软件包文件格式)包，并在项目中新增一个第三方的配置类，同时需要在项目中新增第三方的注解，项目启动时根据配置的注解生成相应规范的接口文档。

这种生成接口文档的方式，引入了第三方jar包，需要学习第三方项目的使用方法，增加学习的成本。同时，因需要新增第三方jar包，所以在打包部署项目时，打包出来的部署的文件较之前更大，让项目变得更加的臃肿。另外，因需要在项目代码增加第三方要求的相关配置，致使自身项目的复杂度上升，增加自身项目的复杂度。整合第三方项目到自身的项目中，存在第三方项目bug导致自身项目崩溃的风险，或第三方项目与自身项目现有代码冲突造成的未知bug，导致自身项目的风险和维护成本上升。

发明内容

本发明的目的在于克服现有技术的不足，提供了一种接口文档的生成方法、装置、计算机设备和存储介质，能够去除项目与接口文档生成装置的耦合性，以降低项目运行时的风险与可能出现bug的几率，同时不需要往项目中添加任何第三方的注解或者是配置文件，从而侧面提升了服务的性能。

为了解决上述中至少一个技术问题，本发明实施例提供了一种接口文档的生成方法，所述方法包括：

在集成开发环境IDE的编辑器中初始化接口代码；

在maven的项目对象模型文件中接入接口文档生成插件，所述接口文档生成插件为maven插件；

在所述项目对象模型的配置文件中配置生成接口文档的目标地址信息、生成接口文档的类路径信息以及生成接口文档的文件格式信息；

启动所述接口文档生成插件，采用所述接口文档生成插件扫描maven管理的项目源码并在所述项目源码中读取所述目标地址信息、所述类路径信息以及所述文件格式信息；

采用所述接口文档生成插件根据所述目标地址信息以及所述类路径信息确定对应的目标代码接口，获取所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容；

采用所述接口文档生成插件根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档。

在其中一个实施例中，所述文件格式信息包括排版格式，所述根据所述文件格式信息以及所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容生成所述目标代码接口的接口文档，包括：

按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档。

在其中一个实施例中，所述方法还包括：确定所述目标代码接口的接口文档的文档语言；

所述按照所述排版格式对所述目标代码接口的接口名称、修饰符号、参数内容以及注释内容进行排版后生成所述目标代码接口的接口文档，包括：