[發(fā)明專利]接口文檔的生成方法、裝置和終端設(shè)備在審
| 申請?zhí)枺?/td> | 202011535639.1 | 申請日： | 2020-12-22 |
| 公開（公告）號： | CN112650533A | 公開（公告）日： | 2021-04-13 |
| 發(fā)明（設(shè)計）人： | 李宗波;張卓韜;楊永幫;鄔秋元;陳曉丹;張濤 | 申請（專利權(quán)）人： | 深圳前海微眾銀行股份有限公司 |
| 主分類號： | G06F8/73 | 分類號： | G06F8/73 |
| 代理公司： | 北京同立鈞成知識產(chǎn)權(quán)代理有限公司 11205 | 代理人： | 張娜;劉芳 |
| 地址： | 518027 廣東省深圳市*** | 國省代碼： | 廣東;44 |
| 權(quán)利要求書： | 查看更多 | 說明書： | 查看更多 |
| 摘要： | |||
| 搜索關(guān)鍵詞： | 接口 文檔 生成 方法 裝置 終端設(shè)備 | ||
本申請?zhí)峁┮环N接口文檔的生成方法、裝置和終端設(shè)備，該方法包括：在接收到用于生成接口文檔的生成請求后，將根據(jù)該生成請求，確定目標(biāo)程序代碼，然后根據(jù)目標(biāo)程序代碼，分別確定請求字段和返回字段，并通過Java反射機制，分別獲取請求字段和返回字段各自對應(yīng)的字段名稱和字段類型，再根據(jù)請求字段和返回字段各自對應(yīng)的字段名稱和字段類型，生成目標(biāo)程序代碼對應(yīng)的接口文檔。本申請?zhí)峁┑慕涌谖臋n的生成方法、裝置和終端設(shè)備可以避免用戶手動編寫接口文檔的現(xiàn)象，從而不僅可以提高接口文檔生成的效率，而且可以降低軟件系統(tǒng)開發(fā)的成本。
技術(shù)領(lǐng)域
本申請涉及計算機技術(shù)，尤其涉及一種接口文檔的生成方法、裝置和終端設(shè)備。
背景技術(shù)
隨著計算機技術(shù)的發(fā)展，越來越多的技術(shù)(大數(shù)據(jù)、分布式、人工智能等)應(yīng)用在金融領(lǐng)域，傳統(tǒng)金融業(yè)正在逐步向金融科技(Fintech)轉(zhuǎn)變，但由于金融行業(yè)的安全性、實時性要求，也對服務(wù)請求技術(shù)提出了更高的要求。目前，在金融科技領(lǐng)域，隨著計算機技術(shù)的不斷發(fā)展，軟件系統(tǒng)的復(fù)雜度也越來越高，程序代碼量也越來越大。
現(xiàn)有技術(shù)中，由于軟件系統(tǒng)可能存在大量的程序代碼，往往需要多名開發(fā)人員共同協(xié)作進(jìn)行軟件系統(tǒng)的開發(fā)。為了便于不同的開發(fā)人員互相了解代碼內(nèi)容，開發(fā)人員除了編寫代碼之外，還需要花費大量時間編寫與軟件系統(tǒng)的程序代碼對應(yīng)的接口文檔，從而不僅導(dǎo)致生成接口文檔的效率較低，而且造成軟件系統(tǒng)的開發(fā)成本較高。
發(fā)明內(nèi)容
為解決現(xiàn)有技術(shù)中存在的問題，本申請?zhí)峁┮环N接口文檔的生成方法、裝置和終端設(shè)備，不僅可以提高接口文檔的生成效率，而且降低了軟件系統(tǒng)的開發(fā)成本。
第一方面，本申請實施例提供了一種接口文檔的生成方法，該接口文檔的生成方法可以包括：
接收用于生成接口文檔的生成請求。
根據(jù)所述生成請求，確定目標(biāo)程序代碼。
根據(jù)所述目標(biāo)程序代碼，分別確定請求字段和返回字段。
通過Java反射機制，分別獲取所述請求字段和所述返回字段各自對應(yīng)的字段名稱和字段類型。
根據(jù)所述請求字段和所述返回字段各自對應(yīng)的字段名稱和字段類型，生成所述目標(biāo)程序代碼對應(yīng)的接口文檔。
在一種可能的實現(xiàn)方式中，所述根據(jù)所述請求字段和所述返回字段各自對應(yīng)的字段名稱和字段類型，生成所述目標(biāo)程序代碼對應(yīng)的接口文檔，包括：
針對所述請求字段和所述返回字段中的任一字段，判斷所述字段的字段類型是否為普通數(shù)據(jù)類型，若所述字段的字段類型不為普通數(shù)據(jù)類型，則根據(jù)所述字段的字段類型，確定所述字段中包括的子字段，并獲取所述子字段對應(yīng)的字段名稱和字段類型，將所述子字段確定為新的字段，并重復(fù)執(zhí)行此步驟，直至所述字段的字段類型為普通數(shù)據(jù)類型。
根據(jù)所述字段的字段名稱和字段類型，以及所述字段對應(yīng)的子字段的字段名稱和字段類型，生成所述目標(biāo)程序代碼對應(yīng)的接口文檔。
在一種可能的實現(xiàn)方式中，所述根據(jù)所述字段的字段名稱和字段類型，以及所述字段對應(yīng)的子字段的字段名稱和字段類型，生成所述目標(biāo)程序代碼對應(yīng)的接口文檔，包括：
獲取與所述目標(biāo)程序代碼對應(yīng)的預(yù)設(shè)模板。
確定所有字段以及所有子字段之間的層級關(guān)系。
將所述字段的字段名稱和字段類型，以及所述字段對應(yīng)的子字段的字段名稱和字段類型，按照所述層級關(guān)系，導(dǎo)入所述預(yù)設(shè)模板中，生成所述接口文檔。
在一種可能的實現(xiàn)方式中，根據(jù)所述目標(biāo)程序代碼，確定請求字段，包括：
獲取所述目標(biāo)程序代碼中多個類。
該專利技術(shù)資料僅供研究查看技術(shù)是否侵權(quán)等信息，商用須獲得專利權(quán)人授權(quán)。該專利全部權(quán)利屬于深圳前海微眾銀行股份有限公司，未經(jīng)深圳前海微眾銀行股份有限公司許可，擅自商用是侵權(quán)行為。如果您想購買此專利、獲得商業(yè)授權(quán)和技術(shù)合作，請聯(lián)系【客服】
本文鏈接：http://www.szxzyx.cn/pat/books/202011535639.1/2.html，轉(zhuǎn)載請聲明來源鉆瓜專利網(wǎng)。
