[發(fā)明專(zhuān)利]一種輕量級(jí)API Server開(kāi)發(fā)框架及開(kāi)發(fā)方法

有效

• 申請(qǐng)?zhí)枺?/td>: 201810130259.6
• 申請(qǐng)日: 2018-02-08
• 公開(kāi)（公告）號(hào): CN108446105B
• 公開(kāi)（公告）日: 2021-09-07
• 發(fā)明（設(shè)計(jì)）人: 鄧敏;張芳松
• 申請(qǐng)（專(zhuān)利權(quán)）人: 廣州亦云信息技術(shù)股份有限公司
• 主分類(lèi)號(hào): G06F8/20
• 分類(lèi)號(hào): G06F8/20;G06F8/30
• 代理公司: 廣州市越秀區(qū)哲力專(zhuān)利商標(biāo)事務(wù)所(普通合伙) 44288
• 代理人: 賴(lài)秀芳;曾嘉儀

1.一種輕量級(jí)API Server開(kāi)發(fā)框架，其特征在于，包括：

API子系統(tǒng)，其用于定義所述API Server所支持的API集合；

Server子系統(tǒng)，其用于提供對(duì)外的API服務(wù)；

Client子系統(tǒng)，其用于調(diào)用所述Server子系統(tǒng)提供的API服務(wù)；

所述API集合中的每一API由三部分定義，分別為API標(biāo)識(shí)、一個(gè)API請(qǐng)求類(lèi)和一個(gè)API響應(yīng)類(lèi)，所述API標(biāo)識(shí)用于區(qū)分不同的API，所述API請(qǐng)求類(lèi)用于定義API的請(qǐng)求參數(shù)，所述API響應(yīng)類(lèi)用于定義API的響應(yīng)參數(shù)；所述API請(qǐng)求類(lèi)用于封裝請(qǐng)求數(shù)據(jù)，以獲得對(duì)應(yīng)的API請(qǐng)求實(shí)例，所述API響應(yīng)類(lèi)用于封裝有關(guān)的API響應(yīng)數(shù)據(jù)；

所述Server子系統(tǒng)包括API實(shí)現(xiàn)類(lèi)庫(kù)、管理器和控制器；所述控制器用于向所述管理器傳遞API的請(qǐng)求數(shù)據(jù)以及用于向所述Client子系統(tǒng)傳遞API的響應(yīng)數(shù)據(jù)；所述管理器用于根據(jù)接收到的API的請(qǐng)求數(shù)據(jù)，調(diào)用API實(shí)現(xiàn)類(lèi)庫(kù)中對(duì)應(yīng)的API實(shí)現(xiàn)類(lèi)，以得到API的響應(yīng)數(shù)據(jù)，并將響應(yīng)數(shù)據(jù)返回給控制器。

2.如權(quán)利要求1所述的輕量級(jí)API Server開(kāi)發(fā)框架，其特征在于，所述Server子系統(tǒng)和所述Client子系統(tǒng)之間采用HTTP協(xié)議實(shí)現(xiàn)通信。

3.如權(quán)利要求2所述的輕量級(jí)API Server開(kāi)發(fā)框架，其特征在于，所述Server子系統(tǒng)，其采用Jetty容器作為WEB容器。

4.如權(quán)利要求2所述的輕量級(jí)API Server開(kāi)發(fā)框架，其特征在于，所述Client子系統(tǒng)調(diào)用API服務(wù)時(shí)，采用GET方式將API的請(qǐng)求參數(shù)以URL參數(shù)的方式提交給所述Server子系統(tǒng)。

5.如權(quán)利要求2所述的輕量級(jí)API Server開(kāi)發(fā)框架，其特征在于，所述輕量級(jí)APIServer開(kāi)發(fā)框架還包括異常處理模塊，所述異常處理模塊通過(guò)HTTP Status Code攜帶異常信息。

6.如權(quán)利要求1-5任一項(xiàng)所述的輕量級(jí)API Server開(kāi)發(fā)框架，其特征在于，所述Server子系統(tǒng)還包括配置讀取模塊和配置文件，所述配置讀取模塊用于讀取配置文件的配置信息，并將配置信息轉(zhuǎn)發(fā)給所述管理器；所述管理器還用于根據(jù)接收到的配置信息，加載對(duì)應(yīng)的API實(shí)現(xiàn)類(lèi)，以獲取該API實(shí)現(xiàn)類(lèi)對(duì)應(yīng)的API標(biāo)識(shí)，并將該API標(biāo)識(shí)更新至服務(wù)注冊(cè)表。

7.一種輕量級(jí)API Server開(kāi)發(fā)方法，其特征在于，應(yīng)用如權(quán)利要求1-6任一項(xiàng)所述的輕量級(jí)API Server開(kāi)發(fā)框架，所述開(kāi)發(fā)方法包括：

根據(jù)業(yè)務(wù)需求確定所述API Server的API集合；

對(duì)于API集合中的每一API，在API子系統(tǒng)中定義對(duì)應(yīng)的API請(qǐng)求類(lèi)和API響應(yīng)類(lèi)；所述API請(qǐng)求類(lèi)用于封裝請(qǐng)求數(shù)據(jù)，以獲得對(duì)應(yīng)的API請(qǐng)求實(shí)例，所述API響應(yīng)類(lèi)用于封裝有關(guān)的API響應(yīng)數(shù)據(jù)；

對(duì)于API集合中的每一API，在Server子系統(tǒng)的API實(shí)現(xiàn)類(lèi)庫(kù)中定義對(duì)應(yīng)的API實(shí)現(xiàn)類(lèi)；

將API子系統(tǒng)、Server子系統(tǒng)和Client子系統(tǒng)部署到對(duì)應(yīng)的系統(tǒng)平臺(tái)上。