[發明專利]接口文檔自動生成方法、系統、終端及存儲介質

在審

• 申請號: 202011073606.X
• 申請日: 2020-10-09
• 公開（公告）號: CN112199331A
• 公開（公告）日: 2021-01-08
• 發明（設計）人: 呂憲偉
• 申請（專利權）人: 平安科技（深圳）有限公司
• 主分類號: G06F16/11
• 分類號: G06F16/11;G06F16/16;G06F8/35;G06F8/41
• 代理公司: 深圳國新南方知識產權代理有限公司 44374
• 代理人: 周雷

本發明公開了一種接口文檔自動生成方法、系統、終端及存儲介質，其中方法包括：接收接口文檔生成請求，接口文檔生成請求包括至少一個項目信息；從至少一個項目信息中提取出每個項目的接口信息；從接口信息中分析出每個接口對應的域名信息；利用接口信息生成接口文檔；將域名信息相同的接口文檔進行聚合再輸出。通過上述方式，本發明能夠批量處理項目的接口信息，自動生成每個接口的Swagger規范的接口文檔，且還能夠對接口文檔按照域名進行聚合，方便用戶快速查看。

技術領域

本申請涉及計算機技術領域，特別是涉及一種接口文檔自動生成方法、系統、終端及存儲介質。

背景技術

在當今互聯網時代，信息系統支撐著線上服務的運轉，信息系統內部的前端服務和后臺服務之間以及信息系統之間的交互，都是通過API(Application ProgrammingInterface，應用程序接口)進行通信的，而互聯網公司服務器開放給客戶端的接口往往非常多，公司內部對于此類接口的文檔卻往往少之又少，造成內部學習交流成本被提高。

目前，接口文檔生成主要通過兩種方式，一種是人工書寫接口文檔，一種是借助自動化接口文檔生成工具。

第一種方式下服務接口文檔是由人工手動編寫，按照接口定義，人工提取接口信息，人工梳理數據關系，然后根據接口定義信息，一個一個字段提取出來寫在文檔上面。每個字段都需要在文檔中注明字段名稱、字段類型、字段是否可以為空、字段的默認值、字段的示例值、字段的描述等。另外字段有基本數據類型和復雜結構體之分，復雜結構體可能有多層嵌套，深度可能多達數層。接口文檔還需要包含每個接口的錯誤碼。當接口數量較多時，這種純機械式手工服務文檔編寫效率低下且容易出錯，準確性無法保證。此外，服務接口變更時，由于沒有人工及時對服務接口文檔更新而造成服務異常的情況也是經常發生。

對于第二種方式，現有的文檔生成工具不適用于批量處理項目接口的情況，即使能夠處理，其生成的接口文檔混雜在一起，仍然需要人工確認后進行一一歸類，同樣需要耗費大量時間，效率低下且不利于對接口文檔的管理。

發明內容

本申請提供一種接口文檔自動生成方法、系統、終端及存儲介質，以解決現有接口文檔生成方式效率低下、不利于管理的問題。

為解決上述技術問題，本申請采用的一個技術方案是：提供一種接口文檔自動生成方法，包括：接收接口文檔生成請求，接口文檔生成請求包括至少一個項目信息；從至少一個項目信息中提取出每個項目的接口信息；從接口信息中分析出每個接口對應的域名信息；利用接口信息生成接口文檔；將域名信息相同的接口文檔進行聚合再輸出。

作為本申請的進一步改進，從至少一個項目中提取出每個項目的接口信息，包括：將至少一個項目的接口信息統一導入至postman的一個collection中；導出collection得到一個JSON格式文件，再對JSON格式文件進行解析，得到每個項目的接口信息。

作為本申請的進一步改進，利用接口信息生成接口文檔，包括：分析接口信息并從接口信息中提取項目名稱信息息；根據項目名稱信息創建存儲文件夾，每個項目的所有接口對應一個存儲文件夾；利用接口信息和Swagger規范生成每個接口對應的接口文檔；基于項目名稱信息將接口文檔存儲至對應的存儲文件夾。

作為本申請的進一步改進，利用接口信息和Swagger規范生成每個接口對應的接口文檔，包括：將接口信息按照預設規則自動轉換為Swagger規范規定格式的參數；將參數填充至預先準備好的文檔模板中，得到每個接口對應的接口文檔。

作為本申請的進一步改進，將接口信息按照預設規則自動轉換為Swagger規范規定格式的參數之后，還包括：判斷每個接口對應的參數中是否包括認證參數；若不包括，則將接口的認證參數設置為默認值并補全至參數中。