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

有效

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

本發(fā)明公開了一種輕量級API Server開發(fā)框架以及輕量級API Server開發(fā)方法，包括Server子系統(tǒng)、Client子系統(tǒng)和API子系統(tǒng)，其中API子系統(tǒng)用于定義API Server所支持的API集合，Server子系統(tǒng)包括有API實(shí)現(xiàn)類庫，其包括有用于定義API業(yè)務(wù)邏輯的API實(shí)現(xiàn)類，在開發(fā)過程中，對于每一API，只需在API子系統(tǒng)添加上一對API請求類和API響應(yīng)類，并根據(jù)實(shí)際業(yè)務(wù)需要，在API實(shí)現(xiàn)類庫中添加對應(yīng)的API實(shí)現(xiàn)類即可，使得開發(fā)人員可以專注在API的編程上，極大減少了編程的代碼量，提高了開發(fā)效率。

技術(shù)領(lǐng)域

本發(fā)明涉及API Server開發(fā)技術(shù)領(lǐng)域，尤其涉及一種輕量級API Server開發(fā)框架以及輕量級API Server開發(fā)方法。

背景技術(shù)

在互聯(lián)網(wǎng)的IT公司中，常常涉及到開發(fā)大型的內(nèi)部業(yè)務(wù)系統(tǒng)，其中一個大的系統(tǒng)由若干分布式部署的子系統(tǒng)組成，不同的子系統(tǒng)之間需要通過公開接口進(jìn)行內(nèi)部網(wǎng)絡(luò)的通信。在這種情況下，為了提高接口模塊的開發(fā)效率，降低開發(fā)、部署、運(yùn)維成本，本申請發(fā)明人提出了一種輕量級API Server開發(fā)框架及開發(fā)方法。

發(fā)明內(nèi)容

為了克服現(xiàn)有技術(shù)的不足，本發(fā)明的目的在于提供一種輕量級API Server開發(fā)框架，能夠提高API Server的開發(fā)效率。本發(fā)明的目的之二在于提供一種輕量級API Server開發(fā)方法，能夠提高API Server的開發(fā)效率。

本發(fā)明的輕量級API Server開發(fā)框架，采用如下技術(shù)方案實(shí)現(xiàn)：

一種輕量級API Server開發(fā)框架，包括：

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

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

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

所述API集合中的每一API由三部分定義，分別為API標(biāo)識、一個API請求類和一個API響應(yīng)類，所述API標(biāo)識用于區(qū)分不同的API，所述API請求類用于定義API的請求參數(shù)，所述API響應(yīng)類用于定義API的響應(yīng)參數(shù)；

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

進(jìn)一步地，所述Server子系統(tǒng)和所述Client子系統(tǒng)之間采用HTTP協(xié)議實(shí)現(xiàn)通信。

進(jìn)一步地，所述Server子系統(tǒng)，其采用Jetty容器作為WEB容器。

進(jìn)一步地，所述Client子系統(tǒng)調(diào)用API服務(wù)時，采用GET方式將API的請求參數(shù)以URL參數(shù)的方式提交給所述Server子系統(tǒng)。

進(jìn)一步地，所述輕量級API Server開發(fā)框架還包括異常處理模塊，所述異常處理模塊通過HTTP Status Code攜帶異常信息。

進(jìn)一步地，所述Server子系統(tǒng)還包括配置讀取模塊和配置文件，所述配置讀取模塊用于讀取配置文件的配置信息，并將配置信息轉(zhuǎn)發(fā)給所述管理器；所述管理器還用于根據(jù)接收到的配置信息，加載對應(yīng)的API實(shí)現(xiàn)類，以獲取該API實(shí)現(xiàn)類對應(yīng)的API標(biāo)識，并將該API標(biāo)識更新至服務(wù)注冊表。

本發(fā)明的輕量級API Server開發(fā)方法，采用如下技術(shù)方案實(shí)現(xiàn)：

一種輕量級API Server開發(fā)方法，應(yīng)用上述的輕量級API Server開發(fā)框架，所述開發(fā)方法包括：

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