[發明專利]一種API文檔查找方法

在審

• 申請號: 202110038672.1
• 申請日: 2021-01-12
• 公開（公告）號: CN112783837A
• 公開（公告）日: 2021-05-11
• 發明（設計）人: 孫全超
• 申請（專利權）人: 北京首汽智行科技有限公司
• 主分類號: G06F16/14
• 分類號: G06F16/14;G06F8/30
• 代理公司: 北京世譽鑫誠專利代理有限公司 11368
• 代理人: 李世端

本發明公開的API文檔查找方法，涉及計算機技術領域，通過nginx工具配置各個API文檔所在服務器的域名，根據各個API文檔所在服務器的域名，生成統一的URL地址，根據URL地址，從Eurake注冊中心獲取對應的API文檔列表，遍歷API文檔列表中的各個API文檔并獲取各個API文檔的檢查路徑healthCheckUrl，根據各個API文檔的檢查路徑healthCheckUrl，獲取各個API文檔的名稱和地址，根據各個API文檔的名稱和地址，查找具體的API文檔，能夠及時發現新增的API文檔，提高了API文檔查看效率及團隊溝通效率。

技術領域

本發明涉及計算機技術領域，具體涉及一種API文檔查找方法。

背景技術

由于目前微服務架構下軟件研發過程本身的復雜性和持續性以及團隊內外溝通的必要性，不同的研發角色(比如：app研發、h5研發、后端研發)之間需要對應用程序接口(Application Programming Interface，API)進行文檔化和規范化處理。

現有的技術方案大多是簡單地引入springfox工具、swagger工具到單個API文檔中，由于該方案存在不同的文檔分散在各個微服務項目中，導致相關研發人員查看某個具體API文檔時需要多步操作。首先，需要研發人員提前溝通API文檔是否已提供，并定位到API文檔所在的環境，其次，需要研發人員在具體的環境中定位API文檔所在服務器的IP地址和端口，再次，需要研發人員通過具體的服務器的IP地址以及端口，整個過程比較繁瑣，以至于影響到API文檔的查找效率，API文檔更新不及時，影響團隊溝通效率。

發明內容

為解決現有技術的不足，本發明實施例提供了一種API文檔查找方法，該方法包括以下步驟：

通過nginx工具配置各個API文檔所在服務器的域名；

根據所述各個API文檔所在服務器的域名，生成統一的URL地址；

根據所述URL地址，從Eurake注冊中心獲取對應的API文檔列表；

遍歷所述API文檔列表中的各個API文檔并獲取所述各個API文檔的檢查路徑healthCheckUrl；

根據所述各個API文檔的檢查路徑healthCheckUrl，獲取所述各個API文檔的名稱和地址；

根據所述各個API文檔的名稱和地址，

根據所述各個API文檔的名稱和地址，查找具體的API文檔。

優選地，在通過nginx工具配置各個API文檔所在服務器的域名之前，所述方法還包括：

利用swagger工具，實時將從Eurake注冊中心獲取的各個API文檔聚合在一起。

優選地，在根據所述URL地址，從Eurake注冊中心獲取對應的API文檔列表之后，所述方法還包括：

利用http協議，跨域請求對所述API文檔列表的一個或多個API文檔進行在線編輯。

優選地，在根據所述URL地址，從Eurake注冊中心獲取對應的API文檔列表之后，所述方法還包括：

利用監聽配置中心，將所述API文檔列表中的各個API文檔設置為有效狀態或無效狀態。

本發明實施例提供的API文檔查找方法具有以下有益效果：

利用swagger工具，實時將從Eurake注冊中心獲取的各個API文檔聚合在一起并統一API文檔的入口，能夠及時發現新增的API文檔，提高了API文檔查看效率及團隊溝通效率。

具體實施方式

以下結合具體實施例對本發明作具體的介紹。