[發明專利]一種API平臺實現方法、裝置、設備及存儲介質

在審

• 申請號: 202011511538.0
• 申請日: 2020-12-18
• 公開（公告）號: CN112612452A
• 公開（公告）日: 2021-04-06
• 發明（設計）人: 丁磊;何婉妮
• 申請（專利權）人: 華人運通（上海）云計算科技有限公司
• 主分類號: G06F8/20
• 分類號: G06F8/20;G06F8/41;G06F8/71;G06F8/73
• 代理公司: 廣州三環專利商標代理有限公司 44202
• 代理人: 麥小嬋;郝傳鑫

本發明公開了一種API平臺實現方法、裝置、設備及存儲介質，所述方法包括：根據初始版本的API接口定義文件和預先設置的服務代理配置文件，生成服務端代理；其中，API接口定義文件是根據預先設定的接口代碼定義生成，接口代碼定義包括：數據類型映射表、元數據和對象定義文件；根據初始版本的API接口定義文件和預設設置的客戶端接口定義文件，生成客戶端SDK；根據初始版本的API接口定義文件、客戶端SDK和服務端代理，將多個微服務聚合生成API平臺；通過預先約定的接口代碼定義生成API接口定義文件，并調用該文件生成客戶端SDK和服務端代理，以聚合微服務形成API平臺，能有效簡化API定義、發布、調用過程，從而提高API開發調試效率。

技術領域

本發明涉及計算機技術領域，尤其涉及一種API平臺實現方法、裝置、設備及存儲介質。

背景技術

隨著微服務技術的廣泛使用，API接口呈現爆炸式的增長。Swagger目前主流的API文檔生成和調試工具，是用于生成、描述、調用和可視化RESTful風格的Web服務，其目標是使客戶端和文件系統作為服務器以同樣的速度來更新Swagger通過將文件的方法，參數和模型緊密集成到服務器端的代碼，允許API來始終保持同步。但在企業級API平臺開發過程中，由于API描述規則過于復雜，注釋書寫內容和代碼有一定重復，有時甚至超過接口的代碼量，采用現有的API文檔生成和調試工具，會降低API開發調試的效率，同時由于現有的API文檔生成和調試工具是基于單體微服務，無法形成統一的企業級API門戶。

發明內容

針對上述問題，本發明的目的在于提供一種API平臺實現方法、裝置、設備及存儲介質，其能有效簡化API定義、發布、調用過程，從而提高API開發調試效率，實現API平臺的自動聚合生成。

第一方面，本發明實施例提供了一種API平臺實現方法，包括：

根據初始版本的API接口定義文件和預先設置的服務代理配置文件，生成服務端代理；其中，所述API接口定義文件是根據預先設定的接口代碼定義生成，所述接口代碼定義包括：數據類型映射表、元數據和對象定義文件；

根據初始版本的API接口定義文件和預設設置的客戶端接口定義文件，生成客戶端SDK；

根據初始版本的API接口定義文件、所述客戶端SDK和所述服務端代理，將多個微服務聚合生成API平臺。

作為上述方案的改進，所述方法還包括：

響應于所述微服務的更新操作，同步更新本地的API接口定義文件；

根據更新后的API接口定義文件，更新所述客戶端SDK和所述服務端代理；

將更新后的客戶端SDK和服務端代理發布到所述API平臺上。

作為上述方案的改進，所述根據初始版本的API接口定義文件和預先設置的服務代理配置文件，生成服務端代理，包括：

提取初始版本的API接口定義文件中的操作語句的定義內容；其中，所述定義內容指示對應的操作定義；

根據所述定義內容，生成初始版本的服務定義文件；

根據初始版本的服務定義文件和所述服務代理配置文件，生成服務端代理。

作為上述方案的改進，根據初始版本的API接口定義文件和預設設置的客戶端接口定義文件，生成客戶端SDK，包括：

根據初始版本的API接口定義文件，生成初始版本的多編程語言接口類源代碼；

根據所述客戶端接口定義文件，生成多編程語言實現類源代碼；

對初始版本的API接口定義文件、初始版本的多編程語言接口類源代碼、所述客戶端接口定義文件以及所述多編程語言實現類源代碼進行二進制編譯，生成客戶端SDK。