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

说明书

本申请涉及一种基于自动程序设计技术的接口信息生成方法、装置、计算机设备和存储介质。所述方法包括：接收终端发送的接口分析请求；所述接口分析请求携带系统标识；从代码仓库中拉取与所述系统标识对应的业务系统的接口代码；所述接口代码中包含Java注释信息；对所述接口代码进行反射解析处理，得到JSON注释信息；将所述JSON注释信息发送至所述终端，以使所述终端解析所述JSON注释信息得到接口信息。采用本方法优化了接口信息生成过程，能够自动高效生成接口信息。

技术领域

本申请涉及计算机技术领域，特别是涉及一种接口信息生成方法、装置、计算机设备和存储介质。

背景技术

在软件项目开发中通常是前后端分离开发，需要由项目组中的前端工程师和后端工程师共同定义接口，编写接口文档，之后根据这个接口文档进行开发，到项目结束前都要一直维护该接口文档。传统方式中，通常只能通过项目组维护的接口文档了解某个接口信息，如果有接口信息管理的在线平台也只能通过人工方式在前端维护。当软件项目涉及的业务系统数量繁多时，人工编写接口信息的工作量巨大，导致无法及时维护接口信息。

发明内容

基于此，有必要针对上述技术问题，提供一种能够自动高效生成接口信息的接口信息生成方法、装置、计算机设备和存储介质。

一种接口信息生成方法，所述方法包括：接收终端发送的接口分析请求；所述接口分析请求携带系统标识；从代码仓库中拉取与所述系统标识对应的业务系统的接口代码；所述接口代码中包含Java注释信息；对所述接口代码进行反射解析处理，得到JSON注释信息；将所述JSON注释信息发送至所述终端，以使所述终端解析所述JSON注释信息得到接口信息。

在其中一个实施例中，所述对所述接口代码进行反射解析处理，得到JSON注释信息，包括：编译所述接口代码，得到多个待处理类文件；每个所述待处理类文件包含类注释信息；从所述多个待处理类文件中筛选出目标类文件；提取所述目标类文件包含的类注释信息中的多个参数对象；解析每个所述参数对象得到对应的属性信息；对解析得到的多个属性信息进行转换处理，得到JSON注释信息。

在其中一个实施例中，所述提取所述目标类文件包含的类注释信息中的多个参数对象，包括：检测所述目标类文件中包含的起始字符串和结束字符串；基于所述起始字符串对应的注释起始位置和所述结束字符串对应的注释结束位置，获取所述目标类文件包含的类注释信息；提取所获取的Java注释信息中的多个参数对象。

在其中一个实施例中，所述从所述多个待处理类文件中筛选出目标类文件，包括：检测每个待处理类文件包含的注释标识；所述注释标识包括类标识、类方法标识和参数标识中的至少一种；基于检测到的注释标识从多个待处理类文件中筛选出目标类文件；所述目标类文件包含与预设的目标标识匹配的注释标识。

在其中一个实施例中，所述方法还包括：检测所述代码仓库发生的代码变更操作；获取所述代码变更操作对应的变更后的接口代码；当存在与所述变更后的接口代码对应的变更前的接口代码时，基于所述变更后的接口代码和所述变更前的接口代码生成变更信息；将所述变更信息发送至所述终端，以使所述终端根据所述变更信息更新相应的接口信息。

在其中一个实施例中，所述方法还包括：接收终端发送的接口信息查询请求；所述查询请求携带系统标识；获取与所述系统标识对应的多个接口信息；每个所述接口信息中包含版本标识；将所述多个版本标识发送至所述终端，以使所述终端检测基于所述多个版本标识的选择操作，并根据所述选择操作生成接口信息展示请求；接收所述接口信息展示请求；所述接口信息展示请求携带选中的版本标识；将与所述选中的版本标识对应的接口信息发送至所述终端。