[发明专利]电子装置、基于springmvc的数据接口及其说明自动生成方法及存储介质

说明书

本发明公开了一种电子装置、基于springmvc的数据接口及其说明自动生成程序方法及存储介质，通过建立预先确定的服务功能对应的springmvc技术框架，基于所述springmvc技术框架将所述服务功能映射为预设类型数据接口；在所述springmvc技术框架中同步写入所述预设类型数据接口的文档说明；扫描所述springmvc技术框架，获取所述springmvc技术框架中的控制器、以及所述控制器之后的注解类信息，发送至预先确定的接口管理平台。实现了将数据接口对应的文档说明程序化，提高了数据接口上传至接口管理平台的工作效率及准确性，且提高了数据接口的可读性。

技术领域

本发明涉及应用程序开发领域，尤其涉及一种电子装置、基于springmvc的数据接口及其说明自动生成方法及存储介质。

背景技术

随着互联网应用的普及，各公司之间通常利用接口管理平台上开放的数据接口(例如uri接口)进行数据的交互，实现服务功能的共享。目前，由于数据接口程序与对应的接口说明文档是独立的文本，导致将数据接口注册到接口管理平台的过程中需要借助人工进行添加配置对应的接口说明文档(例如需要在接口管理平台上编写接口对应的文档说明、或者将预先编制的接口文档说明导入管理平台并保存)，不仅工作效率低容易出错，且文档的更新存储过程存在时间延迟，导致数据接口的可读性延迟。

发明内容

有鉴于此，本发明提出一种电子装置、基于springmvc的数据接口及其说明自动生成方法及存储介质，实现了将数据接口对应的文档说明程序化，提高了数据接口上传至接口管理平台的工作效率及准确性，且提高了数据接口的可读性。

首先，为实现上述目的，本发明提出一种电子装置，所述电子装置包括存储器、及与所述存储器连接的处理器，所述处理器用于执行所述存储器上存储的基于springmvc的数据接口及其说明自动生成程序，所述基于springmvc的数据接口及其说明自动生成程序被所述处理器执行时实现如下步骤：

A1、建立预先确定的服务功能对应的springmvc技术框架，基于所述springmvc技术框架生成所述服务功能与所述预设类型网络协议的数据接口之间的映射关系，所述服务功能定义为所述springmvc技术框架的控制器；

A2、基于所述springmvc技术框架的注解功能，在所述控制器的注解之后利用预先确定的注解类型写入所述预设类型网络协议的数据接口对应的说明；

A3、将所述预设类型网络协议的数据接口及所述对应的说明发送至预先确定的接口管理平台。

进一步地，所述步骤A1包括如下步骤：

将所述预先确定的服务功能定义为所述springmvc技术框架中的控制器；

基于所述springmvc技术框架的注解功能在所述控制器之后通过所述预先确定的注解类型标注一个预设类型java类作为所述预设类型网络协议的数据接口；

在所述控制器的注解之后定义所述java类与控制器之间的映射关系，以确定利用所述预设类型网络协议的数据接口访问到所述控制器。

进一步地，在所述步骤A2中，所述预设类型网络协议的数据接口对应的说明包括：

所述预设类型网络协议功能、调用方法、返回类型、包含的参数以及所述参数的意义。

进一步地，所述预设类型网络协议的数据接口为http的uri接口。

进一步地，所述预先确定的注解类型包括@controller注解、@requestMapping注解、@apiOperation注解、@ApiParam注解。

此外，为实现上述目的，本发明还提供一种基于springmvc的数据接口及其说明自动生成方法，该方法包括如下步骤：