[發明專利]電子裝置、基于springmvc的數據接口及其說明自動生成方法及存儲介質

有效

• 申請號: 201711458087.7
• 申請日: 2017-12-28
• 公開（公告）號: CN108255513B
• 公開（公告）日: 2021-03-16
• 發明（設計）人: 池紅露
• 申請（專利權）人: 平安科技（深圳）有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73;G06F8/71
• 代理公司: 深圳市沃德知識產權代理事務所(普通合伙) 44347
• 代理人: 于志光;郭夢霞

本發明公開了一種電子裝置、基于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的數據接口及其說明自動生成方法，該方法包括如下步驟：