[發明專利]接口信息生成方法、裝置、計算機設備和存儲介質

在審

• 申請號: 201811204701.1
• 申請日: 2018-10-16
• 公開（公告）號: CN109542412A
• 公開（公告）日: 2019-03-29
• 發明（設計）人: 楊志明;李祖正;鄭盛樣;夏志雄;黃澤彬;劉欣巖
• 申請（專利權）人: 平安普惠企業管理有限公司
• 主分類號: G06F8/30
• 分類號: G06F8/30
• 代理公司: 廣州華進聯合專利商標代理有限公司 44224
• 代理人: 王寧

本申請涉及一種基于自動程序設計技術的接口信息生成方法、裝置、計算機設備和存儲介質。所述方法包括：接收終端發送的接口分析請求；所述接口分析請求攜帶系統標識；從代碼倉庫中拉取與所述系統標識對應的業務系統的接口代碼；所述接口代碼中包含Java注釋信息；對所述接口代碼進行反射解析處理，得到JSON注釋信息；將所述JSON注釋信息發送至所述終端，以使所述終端解析所述JSON注釋信息得到接口信息。采用本方法優化了接口信息生成過程，能夠自動高效生成接口信息。

技術領域

本申請涉及計算機技術領域，特別是涉及一種接口信息生成方法、裝置、計算機設備和存儲介質。

背景技術

在軟件項目開發中通常是前后端分離開發，需要由項目組中的前端工程師和后端工程師共同定義接口，編寫接口文檔，之后根據這個接口文檔進行開發，到項目結束前都要一直維護該接口文檔。傳統方式中，通常只能通過項目組維護的接口文檔了解某個接口信息，如果有接口信息管理的在線平臺也只能通過人工方式在前端維護。當軟件項目涉及的業務系統數量繁多時，人工編寫接口信息的工作量巨大，導致無法及時維護接口信息。

發明內容

基于此，有必要針對上述技術問題，提供一種能夠自動高效生成接口信息的接口信息生成方法、裝置、計算機設備和存儲介質。

一種接口信息生成方法，所述方法包括：接收終端發送的接口分析請求；所述接口分析請求攜帶系統標識；從代碼倉庫中拉取與所述系統標識對應的業務系統的接口代碼；所述接口代碼中包含Java注釋信息；對所述接口代碼進行反射解析處理，得到JSON注釋信息；將所述JSON注釋信息發送至所述終端，以使所述終端解析所述JSON注釋信息得到接口信息。

在其中一個實施例中，所述對所述接口代碼進行反射解析處理，得到JSON注釋信息，包括：編譯所述接口代碼，得到多個待處理類文件；每個所述待處理類文件包含類注釋信息；從所述多個待處理類文件中篩選出目標類文件；提取所述目標類文件包含的類注釋信息中的多個參數對象；解析每個所述參數對象得到對應的屬性信息；對解析得到的多個屬性信息進行轉換處理，得到JSON注釋信息。

在其中一個實施例中，所述提取所述目標類文件包含的類注釋信息中的多個參數對象，包括：檢測所述目標類文件中包含的起始字符串和結束字符串；基于所述起始字符串對應的注釋起始位置和所述結束字符串對應的注釋結束位置，獲取所述目標類文件包含的類注釋信息；提取所獲取的Java注釋信息中的多個參數對象。

在其中一個實施例中，所述從所述多個待處理類文件中篩選出目標類文件，包括：檢測每個待處理類文件包含的注釋標識；所述注釋標識包括類標識、類方法標識和參數標識中的至少一種；基于檢測到的注釋標識從多個待處理類文件中篩選出目標類文件；所述目標類文件包含與預設的目標標識匹配的注釋標識。

在其中一個實施例中，所述方法還包括：檢測所述代碼倉庫發生的代碼變更操作；獲取所述代碼變更操作對應的變更后的接口代碼；當存在與所述變更后的接口代碼對應的變更前的接口代碼時，基于所述變更后的接口代碼和所述變更前的接口代碼生成變更信息；將所述變更信息發送至所述終端，以使所述終端根據所述變更信息更新相應的接口信息。

在其中一個實施例中，所述方法還包括：接收終端發送的接口信息查詢請求；所述查詢請求攜帶系統標識；獲取與所述系統標識對應的多個接口信息；每個所述接口信息中包含版本標識；將所述多個版本標識發送至所述終端，以使所述終端檢測基于所述多個版本標識的選擇操作，并根據所述選擇操作生成接口信息展示請求；接收所述接口信息展示請求；所述接口信息展示請求攜帶選中的版本標識；將與所述選中的版本標識對應的接口信息發送至所述終端。