[發明專利]一種輕量級API Server開發框架及開發方法

有效

• 申請號: 201810130259.6
• 申請日: 2018-02-08
• 公開（公告）號: CN108446105B
• 公開（公告）日: 2021-09-07
• 發明（設計）人: 鄧敏;張芳松
• 申請（專利權）人: 廣州亦云信息技術股份有限公司
• 主分類號: G06F8/20
• 分類號: G06F8/20;G06F8/30
• 代理公司: 廣州市越秀區哲力專利商標事務所(普通合伙) 44288
• 代理人: 賴秀芳;曾嘉儀

1.一種輕量級API Server開發框架，其特征在于，包括：

API子系統，其用于定義所述API Server所支持的API集合；

Server子系統，其用于提供對外的API服務；

Client子系統，其用于調用所述Server子系統提供的API服務；

所述API集合中的每一API由三部分定義，分別為API標識、一個API請求類和一個API響應類，所述API標識用于區分不同的API，所述API請求類用于定義API的請求參數，所述API響應類用于定義API的響應參數；所述API請求類用于封裝請求數據，以獲得對應的API請求實例，所述API響應類用于封裝有關的API響應數據；

所述Server子系統包括API實現類庫、管理器和控制器；所述控制器用于向所述管理器傳遞API的請求數據以及用于向所述Client子系統傳遞API的響應數據；所述管理器用于根據接收到的API的請求數據，調用API實現類庫中對應的API實現類，以得到API的響應數據，并將響應數據返回給控制器。

2.如權利要求1所述的輕量級API Server開發框架，其特征在于，所述Server子系統和所述Client子系統之間采用HTTP協議實現通信。

3.如權利要求2所述的輕量級API Server開發框架，其特征在于，所述Server子系統，其采用Jetty容器作為WEB容器。

4.如權利要求2所述的輕量級API Server開發框架，其特征在于，所述Client子系統調用API服務時，采用GET方式將API的請求參數以URL參數的方式提交給所述Server子系統。

5.如權利要求2所述的輕量級API Server開發框架，其特征在于，所述輕量級APIServer開發框架還包括異常處理模塊，所述異常處理模塊通過HTTP Status Code攜帶異常信息。

6.如權利要求1-5任一項所述的輕量級API Server開發框架，其特征在于，所述Server子系統還包括配置讀取模塊和配置文件，所述配置讀取模塊用于讀取配置文件的配置信息，并將配置信息轉發給所述管理器；所述管理器還用于根據接收到的配置信息，加載對應的API實現類，以獲取該API實現類對應的API標識，并將該API標識更新至服務注冊表。

7.一種輕量級API Server開發方法，其特征在于，應用如權利要求1-6任一項所述的輕量級API Server開發框架，所述開發方法包括：

根據業務需求確定所述API Server的API集合；

對于API集合中的每一API，在API子系統中定義對應的API請求類和API響應類；所述API請求類用于封裝請求數據，以獲得對應的API請求實例，所述API響應類用于封裝有關的API響應數據；

對于API集合中的每一API，在Server子系統的API實現類庫中定義對應的API實現類；

將API子系統、Server子系統和Client子系統部署到對應的系統平臺上。