[發(fā)明專利]接口文檔生成與查詢方法、裝置及計算機(jī)可讀存儲介質(zhì)

在審

• 申請?zhí)枺?/td>: 202011645338.4
• 申請日: 2020-12-30
• 公開（公告）號: CN112685078A
• 公開（公告）日: 2021-04-20
• 發(fā)明（設(shè)計）人: 李翠
• 申請（專利權(quán)）人: 平安證券股份有限公司
• 主分類號: G06F8/73
• 分類號: G06F8/73;G06F16/33
• 代理公司: 深圳市沃德知識產(chǎn)權(quán)代理事務(wù)所(普通合伙) 44347
• 代理人: 高杰;于志光

本發(fā)明涉及數(shù)據(jù)處理技術(shù)領(lǐng)域，揭露一種接口文檔生成與查詢方法，包括：獲取接口項目創(chuàng)建指令，創(chuàng)建與所述接口項目對應(yīng)的文檔項目，在項目關(guān)系表中存儲所述接口項目與所述文檔項目的關(guān)聯(lián)關(guān)系；創(chuàng)建或更新接口項目的功能模塊，并在所述文檔項目中生成或更新與所述功能模塊關(guān)聯(lián)的接口文檔；當(dāng)接收到接口文檔查詢請求時，根據(jù)所述接口文檔查詢請求中的功能模塊標(biāo)識查找對應(yīng)的接口文檔，并返回所述對應(yīng)的接口文檔。本發(fā)明還涉及區(qū)塊鏈技術(shù)，所述接口文檔存儲于區(qū)塊鏈中。本發(fā)明根據(jù)功能模塊自動生成和管理關(guān)聯(lián)接口，減少了人工編輯文檔的成本和后期的維護(hù)成本，保證了接口和文檔的一致性，從而方便快捷的實現(xiàn)接口文檔生成與查詢。

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

本發(fā)明涉及數(shù)據(jù)處理技術(shù)領(lǐng)域，尤其涉及一種接口文檔生成與查詢方法、電子裝置及計算機(jī)可讀存儲介質(zhì)。

背景技術(shù)

目前，在生成接口文檔時，通常將接口的定義作為接口文檔，采用一個接口對應(yīng)一個接口文檔的形式，而在接口項目中一個功能模塊會涉及到多個接口，需要查看多個接口文檔才能預(yù)覽該功能模塊的所有接口，使用不方便。現(xiàn)有技術(shù)中，在查詢某一接口項目或某一功能模塊的接口文檔時，需要逐個查詢對應(yīng)的接口文檔，當(dāng)接口項目或功能模塊涉及到多個接口時，常將大量接口不加區(qū)分地全部展示，不夠清晰便捷。

因此，如何方便快捷的實現(xiàn)接口文檔生成與查詢已經(jīng)成為一個亟待解決的技術(shù)問題。

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

鑒于以上內(nèi)容，有必要提供一種接口文檔生成與查詢方法，用于方便快捷的實現(xiàn)接口文檔生成與查詢。

本發(fā)明提供的接口文檔生成與查詢方法，應(yīng)用于電子裝置，包括：

獲取接口項目創(chuàng)建指令，創(chuàng)建與所述接口項目對應(yīng)的文檔項目，在項目關(guān)系表中存儲所述接口項目與所述文檔項目的關(guān)聯(lián)關(guān)系；

創(chuàng)建或更新接口項目的功能模塊，并在所述文檔項目中生成或更新與所述功能模塊關(guān)聯(lián)的接口文檔；

當(dāng)接收到接口文檔查詢請求時，根據(jù)所述接口文檔查詢請求中的功能模塊標(biāo)識查找對應(yīng)的接口文檔，并返回所述對應(yīng)的接口文檔。

可選的，所述在所述文檔項目中生成或更新與所述功能模塊關(guān)聯(lián)的接口文檔包括：

根據(jù)文檔關(guān)聯(lián)表查詢所述文檔項目中是否存儲與所述功能模塊關(guān)聯(lián)的接口文檔；

若所述文檔項目中未存儲與所述功能模塊關(guān)聯(lián)的接口文檔，生成與所述功能模塊關(guān)聯(lián)的接口文檔并存儲到所述文檔項目中，并在文檔關(guān)聯(lián)表中存儲所述功能模塊與所述接口文檔的關(guān)聯(lián)關(guān)系；

若所述文檔項目中存儲有與所述功能模塊關(guān)聯(lián)的接口文檔，更新所述文檔項目中與所述功能模塊關(guān)聯(lián)的接口文檔。

可選的，所述生成與所述功能模塊關(guān)聯(lián)的接口文檔并存儲到所述文檔項目中包括：

在所述文檔項目中新建接口文檔，遍歷讀取所述功能模塊的各個接口信息，并按照預(yù)先設(shè)置的格式將所述功能模塊的各個接口信息寫入所述文檔項目中新建的接口文檔。

可選的，所述更新所述文檔項目中與所述功能模塊關(guān)聯(lián)的接口文檔包括：

遍歷讀取所述功能模塊的各個接口信息，讀取與所述功能模塊關(guān)聯(lián)的接口文檔中文檔關(guān)聯(lián)的接口并判斷所述功能模塊是否有新增、刪除或更新接口；

若所述功能模塊有新增接口，則將所述新增接口追加至與所述功能模塊關(guān)聯(lián)的接口文檔中；

若所述功能模塊有更新接口，則將更新后的接口替換掉與所述功能模塊關(guān)聯(lián)的接口文檔中的被更新接口；

若所述功能模塊刪除了接口，則從與所述功能模塊關(guān)聯(lián)的接口文檔中移除該接口。

可選的，所述接口項目包括一個或多個功能模塊，所述功能模塊包括一個或多個接口。