接口文档生成方法、装置、设备和存储介质与流程

    技术2025-03-19  40


    本发明涉及网络安全领域,尤其涉及一种接口文档生成方法、装置、设备和存储介质。


    背景技术:

    1、在专网运营平台研发和测试过程中,前端研发或测试人员需要获取在线接口文档并且在线接口文档上调用相关接口进行调试。现有常用的接口文档生成方式为利用swagger组件生成,swagger组件主要包括程序逻辑、swagger注解标签、swagger前端静态资源,swagger是一款可用于设计、构建、文档化并且执行api的框架。但是,由于swagger组件的使用方法是需要当前工程引入该组件包,即将swagger组件打包至当前工程包,如图1所示,此时的生产环境和测试环境的应用程序包中均含有swagger组件,因此在使用swagger组件生成接口文档时,软件上线后会连带打包的swagger组件上线,由于swagger组件的程序开发者在开发时需要在代码使用规范的swagger注解,导致其它代码或者设计要做相应的更改以适应新组件,不利于代码的复用,具有一定的侵入性,以及swagger组件会伴随软件开发生命周期从开发、测试到生产一直存在应用程序中,虽然生产环境swagger可对前端页面进行禁用配置,但从历史版本安全漏洞情况看来,已发生过多次安全问题,存在安全漏洞。


    技术实现思路

    1、本发明实施例的目的是提供一种接口文档生成方法、装置、设备和存储介质,无需使用规范的特殊注解,对程序完全无侵入性,无需在项目工程中引入swagger组件,swagger组件不会贯穿软件开发的整个生命周期,提高系统安全性。

    2、为实现上述目的,本发明实施例提供了一种接口文档生成方法,包括:

    3、获取目标项目工程中的目标应用代码;其中,所述目标项目工程为预设文件待引用的项目工程;

    4、对所述目标应用代码进行扫描,得到含有接口信息的参数注释信息;

    5、根据所述参数注释信息生成接口文档。

    6、作为上述方案的改进,所述根据所述参数注释信息生成接口文档,包括:

    7、将所述参数注释信息写入内存的对象列表中;

    8、在所述对象列表中解析出所述参数注释信息,并将解析得到的参数注释信息渲染到静态资源中,生成接口文档。

    9、作为上述方案的改进,所述对所述目标应用代码进行扫描,包括:

    10、利用代码抽取工具通过配置文件中指定的接口文件路径对所述目标应用代码进行扫描。

    11、作为上述方案的改进,所述代码抽取工具为jdk工具包中的javadoc。

    12、作为上述方案的改进,所述目标应用代码预先采用java注释的规范进行注释。

    13、作为上述方案的改进,所述预设文件为pom文件或gradle文件。

    14、作为上述方案的改进,所述静态资源中含有接口文档配置模板;则,所述将解析得到的参数注释信息渲染到静态资源中,包括:

    15、将解析得到的参数注释信息渲染到所述静态资源的接口文档配置模板中。

    16、为实现上述目的,本发明实施例还提供了一种接口文档生成装置,包括:

    17、目标应用代码打包模块,用于获取目标项目工程中的目标应用代码;其中,所述目标项目工程为预设文件待引用的项目工程;

    18、参数注释信息获取模块,用于对所述目标应用代码进行扫描,得到含有接口信息的参数注释信息;

    19、接口文档生成模块,用于根据所述参数注释信息生成接口文档。

    20、为实现上述目的,本发明实施例还提供了一种接口文档生成设备,包括处理器、存储器以及存储在所述存储器中且被配置为由所述处理器执行的计算机程序,所述处理器执行所述计算机程序时实现如上述任一实施例所述的接口文档生成方法。

    21、为实现上述目的,本发明实施例还提供了一种计算机可读存储介质,所述计算机可读存储介质包括存储的计算机程序,其中,在所述计算机程序运行时控制所述计算机可读存储介质所在设备执行如上述任一实施例所述的接口文档生成方法。

    22、相比于现有技术,本发明公开的接口文档生成方法、装置、设备和存储介质,在生成接口文档的过程中,首先获取目标项目工程中的目标应用代码;其中,这一目标项目工程为预设文件待引用的项目工程,由此实现接口文档生成装置反向引用所要开发或测试的工程,对其进行打包,而不是所要开发的工程对组件包进行引用,除按照规定编写接口注释信息外,无需修改目标应用代码;在打包目标应用代码后,对所述目标应用代码进行扫描,得到含有接口信息的参数注释信息,并根据所述参数注释信息生成接口文档。采用本发明实施例,无需使用规范的特殊swagger注解,对程序完全无侵入性,以及无需在项目工程中引入swagger组件,swagger组件不会贯穿软件开发的整个生命周期,提高系统安全性。



    技术特征:

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

    2.如权利要求1所述的接口文档生成方法,其特征在于,所述根据所述参数注释信息生成接口文档,包括:

    3.如权利要求1所述的接口文档生成方法,其特征在于,所述对所述目标应用代码进行扫描,包括:

    4.如权利要求3所述的接口文档生成方法,其特征在于,所述代码抽取工具为jdk工具包中的javadoc。

    5.如权利要求1所述的接口文档生成方法,其特征在于,所述目标应用代码预先采用java注释的规范进行注释。

    6.如权利要求1所述的接口文档生成方法,其特征在于,所述预设文件为pom文件或gradle文件。

    7.如权利要求2所述的接口文档生成方法,其特征在于,所述静态资源中含有接口文档配置模板;则,所述将解析得到的参数注释信息渲染到静态资源中,包括:

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

    9.一种接口文档生成设备,其特征在于,包括处理器、存储器以及存储在所述存储器中且被配置为由所述处理器执行的计算机程序,所述处理器执行所述计算机程序时实现如权利要求1至7中任意一项所述的接口文档生成方法。

    10.一种计算机可读存储介质,其特征在于,所述计算机可读存储介质包括存储的计算机程序,其中,在所述计算机程序运行时控制所述计算机可读存储介质所在设备执行如权利要求1至7中任意一项所述的接口文档生成方法。


    技术总结
    本发明公开了一种接口文档生成方法、装置、设备和存储介质,在生成接口文档的过程中,首先获取目标项目工程中的目标应用代码;其中,这一目标项目工程为预设文件待引用的项目工程,由此实现接口文档生成装置反向引用所要开发或测试的工程,对其进行打包,而不是所要开发的工程对组件包进行引用,除按照规定编写接口注释信息外,无需修改目标应用代码;在打包目标应用代码后,对所述目标应用代码进行扫描,得到含有接口信息的参数注释信息,并根据所述参数注释信息生成接口文档。采用本发明实施例,无需使用规范的特殊swagger注解,对程序完全无侵入性,以及无需在项目工程中引入swagger组件,swagger组件不会贯穿软件开发的整个生命周期,提高系统安全性。

    技术研发人员:陈安林,李司坤,刘健,普加红,马俊
    受保护的技术使用者:中移物联网有限公司
    技术研发日:
    技术公布日:2024/10/24
    转载请注明原文地址:https://symbian.8miu.com/read-27786.html

    最新回复(0)