[發(fā)明專利]一種API版本控制方法及裝置

有效

• 申請?zhí)枺?/td>: 201811287782.6
• 申請日: 2018-10-31
• 公開（公告）號: CN111124474B
• 公開（公告）日: 2022-02-15
• 發(fā)明（設計）人: 丁碩青;肖士良;馮駿驊;趙鵬
• 申請（專利權）人: 北京數(shù)聚鑫云信息技術有限公司
• 主分類號: G06F8/71
• 分類號: G06F8/71
• 代理公司: 北京名華博信知識產(chǎn)權代理有限公司 11453
• 代理人: 白瑩;苗源

本發(fā)明公開了一種API版本控制方法及裝置。所公開的方法包括：存儲不同項目、不同API的不同版本的配置文件；基于指定的項目信息、API的版本信息，動態(tài)加載指定項目、指定版本的API的配置文件，其中，配置文件包括下列信息中的至少一項：API訪問路徑、請求方法、請求參數(shù)、響應格式。所公開的技術方案能夠快速地動態(tài)加載指定版本的API配置文件。

技術領域

本發(fā)明涉及軟件工程和數(shù)據(jù)庫領域，尤其涉及一種API版本控制方法及裝置。

背景技術

隨著計算機軟件和數(shù)據(jù)庫產(chǎn)業(yè)的快速發(fā)展，API在企業(yè)中起到的作用越來越重要。API既可以作為企業(yè)內(nèi)部不同業(yè)務系統(tǒng)之間的橋梁，進行不同業(yè)務系統(tǒng)之間的數(shù)據(jù)交換或集成；也可以作為企業(yè)和合作伙伴之間的樞紐，進行數(shù)據(jù)的共享。隨著企業(yè)業(yè)務的發(fā)展和變化，企業(yè)中的API也會相應隨之變化，因此，API的版本控制就顯得尤為重要。如何在業(yè)務變更或者遇到故障時，能夠快速地切換API的版本，這將是企業(yè)數(shù)字化過程中必須解決的一個問題。

現(xiàn)有技術通常采用專用的代碼版本控制工具(例如，git、SVN等)來對API服務的源代碼進行管理，通過切換代碼版本的方式來進行服務回滾和升級。

然而，現(xiàn)有技術方案卻存在以下缺點：

1、低效：由于切換API版本時需要針對不同代碼重新對API服務進行編譯，會影響切換的效率。

2、冗余：無論API服務變更的大小，每次變更都需要保存全量的代碼。

3、服務中斷：在切換API服務版本時很可能需要服務重啟，會導致服務中斷。

4、依賴源碼：對源碼過度依賴。

為了解決上述問題，需要提出新的技術方案。

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

根據(jù)本發(fā)明的API版本控制方法，包括：

存儲不同項目、不同API的不同版本的配置文件；

基于指定的項目信息、API的版本信息，動態(tài)加載指定項目、指定版本的API的配置文件，

其中，配置文件包括下列信息中的至少一項：API訪問路徑、請求方法、請求參數(shù)、響應格式。

根據(jù)本發(fā)明的API版本控制方法，還包括：

構建分別用于存儲項目信息、API屬性信息、API版本信息、API擴展信息的數(shù)據(jù)實體，來存儲與進行API版本控制相關的信息，

其中，與進行API版本控制相關的信息以日志方式存儲在數(shù)據(jù)庫中。

根據(jù)本發(fā)明的API版本控制方法，還包括：

基于項目ID字段project_id來標識項目的唯一性，基于版本ID字段version_id來標識API版本的唯一性，在用于存儲API版本信息的數(shù)據(jù)實體中存儲與API版本相關的信息，

其中，用于存儲API版本信息的數(shù)據(jù)實體是api_version表。

根據(jù)本發(fā)明的API版本控制方法，還包括：

基于指定項目名稱，確定與指定項目名稱關聯(lián)的project_id的值，查找與project_id的值對應的、上線狀態(tài)字段status的值online所對應的、api_version表中的表項，將所查找到的表項中的status的值設置為offline，將需要動態(tài)加載的指定版本的API所對應的、api_version表中的表項中的status的值設置為online，以完成動態(tài)加載。

根據(jù)本發(fā)明的API版本控制方法，還包括：