[發明專利]接口文檔的生成方法、裝置、設備及計算機可讀存儲介質

在審

• 申請號: 202010617452.X
• 申請日: 2020-06-29
• 公開（公告）號: CN111767096A
• 公開（公告）日: 2020-10-13
• 發明（設計）人: 曾凱瑤;盧道和;黃葉飛;邊元喬;陳澄;周瑞哲;李建廷;黃彥淇;高銀川;呂定剛;李婷;陳小鋒;商市盛;畢玉龍
• 申請（專利權）人: 深圳前海微眾銀行股份有限公司
• 主分類號: G06F9/448
• 分類號: G06F9/448;G06F16/958
• 代理公司: 深圳市世紀恒程知識產權代理事務所 44287
• 代理人: 張婷

本發明涉及金融科技技術領域，公開了一種接口文檔的生成方法、裝置、設備及計算機可讀存儲介質。該接口文檔的生成方法包括：獲取接口對應的源文件；從所述源文件中確定第一對象對應的第一目標參數，所述第一對象包括接口名、請求路徑以及資源處理方法；從所述源文件中確定第二對象對應的第二目標參數，所述第二對象包括請求以及返回對象；根據所述第一目標參數以及所述第二目標參數生成接口文檔。本發明通過接口的源文件即可解析接口的結構得到目標參數，無需依托于項目的運行獲取目標參數，避免了手寫接口文檔，不僅生成接口文檔不受項目進度限制，還保證了接口文檔的生成效率。

技術領域

本發明涉及金融科技(Fintech)技術領域，尤其涉及一種接口文檔的生成方法、裝置、設備及計算機可讀存儲介質。

背景技術

隨著計算機技術的發展，越來越多的技術應用在金融領域，傳統金融業正在逐步向金融科技(Fintech)轉變，但由于金融行業的安全性、實時性要求，也對技術提出了更高的要求。

網絡架構中，前端以及后端需要通過接口文檔進行交流。具體地，通過解析接口的結構，從而根據解析的結構得到接口文檔。現有的用于解析接口的結構的工具是在項目運行的基礎上執行的，若是項目還在開發階段，項目運行不成功，使得用于解析接口結構工具無法生效，導致需要手寫接口文檔，接口文檔的生成效率較低。

發明內容

本發明的主要目的在于提供一種接口文檔的生成方法、裝置、設備及計算機可讀存儲介質，旨在解決接口文檔的生成受限，且生成效率較低的問題。

為實現上述目的，本發明提供一種接口文檔的生成方法，所述接口文檔的生成方法包括：

獲取接口對應的源文件；

從所述源文件中確定第一對象對應的第一目標參數，所述第一對象包括接口名、請求路徑以及資源處理方法；

從所述源文件中確定第二對象對應的第二目標參數，所述第二對象包括請求以及返回對象；

根據所述第一目標參數以及所述第二目標參數生成接口文檔。

在一實施例中，所述從所述源文件中確定第一對象對應的第一目標參數的步驟包括：

從所述源文件中提取所述第一對象的第一參數；

在所述第一參數為字符串時，將所述第一參數確定為所述第一對象的第一目標參數；

在所述第一參數為數組或者常量時，將所述第一參數分割為至少一個要素，并根據所述要素確定所述第一對象對應的第一目標參數。

在一實施例中，所述根據所述要素確定所述第一對象對應的第一目標參數的步驟包括：

去除包括第一預設符號的所述要素得到剩余的各個所述要素；

根據剩余的各個所述要素確定所述第一對象對應的第一目標參數。

在一實施例中，所述根據所述要素確定所述第一對象對應的第一目標參數的步驟包括：

確定具有引用的第二參數的所述要素；

根據各個所述第二參數以及不具有引用第二參數的各個所述要素，確定所述第一對象對應的第一目標參數。

在一實施例中，所述從所述源文件中確定第二對象對應的第二目標參數的步驟包括：

從所述源文件中提取所述第二對象對應的第三參數；

確定所述第三參數對應的類型；

根據所述類型以及所述第三參數，確定所述第二對象對應的第二目標參數。

在一實施例中，所述根據所述類型以及所述第三參數，確定所述第二對象對應的第二目標參數的步驟包括：