[發明專利]接口代碼自動同步方法、裝置及存儲介質

在審

• 申請號: 202010122958.3
• 申請日: 2020-02-27
• 公開（公告）號: CN111367547A
• 公開（公告）日: 2020-07-03
• 發明（設計）人: 譚龍智
• 申請（專利權）人: 平安國際智慧城市科技股份有限公司
• 主分類號: G06F8/65
• 分類號: G06F8/65;G06F8/41;G06F8/71
• 代理公司: 北京鴻元知識產權代理有限公司 11327
• 代理人: 袁文婷;王迎

本發明涉及開發輔助領域，提出一種接口代碼自動同步方法、裝置及計算機可讀存儲介質，該方法包括：在接口描述文件里面定義API屬性；所述API屬性包括：接口名稱、請求參數和返回值；根據所述接口描述文件中的API屬性生成各端的接口代碼，各端的接口代碼統一構成代碼文件；在所述代碼文件中提取代碼特征構成代碼特征集合，根據所述接口描述文件和所述代碼特征集合生成代碼指紋；所述代碼特征依靠AC提?。槐容^代碼指紋與描述文件中的API屬性，判斷代碼是否更改，若代碼更改，則根據接口描述文件自動生成新代碼，并將所述新代碼保存在代碼服務器。

技術領域

本發明涉及開發輔助領域，尤其涉及一種接口代碼自動同步方法、裝置及計算機可讀存儲介質。

背景技術

在面向對象的程序開發中的類不支持客觀世界中事物對象之間多重繼承的情況，程序開發人員為了克服單一繼承的缺點，解決多重繼承的問題的背景下提出了接口的概念。在軟件開發過程中，不可避免的會遇到新增接口參數、修改接口返回值、修改接口版本號等問題，為此所有調用此接口的客戶端都需要重新改動，以達到接口兼容的目的，這種接口同步方式最大的問題是步驟繁瑣，容易出錯。

目前業界雖有通過接口描述文件自動生成接口代碼的方式，但普遍停留在代碼生成階段，其前后端協作都是圍繞定義的接口進行，現有的交互方式存在很多不足：很多時間花費在接口聯調上面，經常因為接口一個小的調整，例如修改接口參數，前后端代碼都得重新修改和聯調，消耗太多不必要的人力；開發效率低，接口維護成本大，人工維護接口，很多時間花在同步和溝通上面，如果信息不能及時同步，各端接口因版本不一致容易出現線上事故；沒有接口規范約束，接口代碼各端不一致，幾乎每個項目都有自己的規范，從一個項目換到另一個項目需要重新熟悉規范，增加學習成本；沒有解決接口版本同步端都有可能修改接口代碼的問題，依靠人為主動同步修改才能保持一致。

因此，亟須一種接口代碼自動同步方法，以提高了軟件開發過程中多端合作的效率，避免人為疏忽導致代碼未及時更新到最新版本的問題，從而提高軟件的穩定性。

發明內容

本發明提供一種接口代碼自動同步方法、電子裝置及計算機可讀存儲介質，其主要目的在于通過在所述接口描述文件里面定義API屬性，然后通過所述接口描述文件生成各端的接口代碼，各端的接口代碼統一構成代碼文件，進而在所述代碼文件中提取代碼特征構成代碼特征集合，根據所述接口描述文件和所述代碼特征集合生成代碼指紋；所述代碼特征依靠AC獲取，再比較代碼指紋與接口描述文件是否一致，若不一致，則根據接口描述文件自動生成新代碼，并將所述新代碼保存在代碼服務器，當各端再次編譯代碼，則直接在所述代碼服務器中拉取所述新代碼，以提高了軟件開發過程中多端合作的效率，避免人為疏忽導致代碼未及時更新到最新版本的問題，從而提高軟件的穩定性。

為實現上述目的，本發明提供的方法，應用于電子裝置，所述接口代碼自動同步方法包括：

在接口描述文件中定義API屬性；所述API屬性包括：接口名稱、請求參數和返回值；

根據所述接口描述文件中的API屬性生成各端的接口代碼，然后將各端的接口代碼統一構成代碼文件；

在所述代碼文件中提取代碼特征構成代碼特征集合，根據所述代碼特征集合生成代碼指紋；

比較所述代碼指紋與所述接口描述文件中的API屬性，判斷代碼是否更改，若代碼更改，則根據所述接口描述文件自動生成新代碼，并將所述新代碼保存至代碼服務器。

優選地，所述接口描述文件為基于Open API語法規則定義的json或xml格式的文件，所述接口描述文件按照Open API規則定義了所有接口的基本信息；所述基本信息至少包括API屬性。

優選地，根據所述接口描述文件生成各端接口代碼的過程包括：

選擇生成各端代碼的模板文件；