[發(fā)明專利]接口文檔自動生成方法、系統(tǒng)、終端及存儲介質(zhì)在審
| 申請?zhí)枺?/td> | 202011073606.X | 申請日： | 2020-10-09 |
| 公開（公告）號： | CN112199331A | 公開（公告）日： | 2021-01-08 |
| 發(fā)明（設(shè)計）人： | 呂憲偉 | 申請（專利權(quán)）人： | 平安科技（深圳）有限公司 |
| 主分類號： | G06F16/11 | 分類號： | G06F16/11;G06F16/16;G06F8/35;G06F8/41 |
| 代理公司： | 深圳國新南方知識產(chǎn)權(quán)代理有限公司 44374 | 代理人： | 周雷 |
| 地址： | 518000 廣東省深圳市福田區(qū)福*** | 國省代碼： | 廣東;44 |
| 權(quán)利要求書： | 查看更多 | 說明書： | 查看更多 |
| 摘要： | |||
| 搜索關(guān)鍵詞： | 接口 文檔 自動 生成 方法 系統(tǒng) 終端 存儲 介質(zhì) | ||
1.一種接口文檔自動生成方法，其特征在于，包括：
接收接口文檔生成請求，所述接口文檔生成請求包括至少一個項目信息；
從所述至少一個項目信息中提取出每個項目的接口信息；
從所述接口信息中分析出每個接口對應(yīng)的域名信息；
利用所述接口信息生成接口文檔；
將域名信息相同的接口文檔進(jìn)行聚合再輸出。
2.根據(jù)權(quán)利要求1所述的接口文檔自動生成方法，其特征在于，所述從所述至少一個項目中提取出每個項目的接口信息，包括：
將所述至少一個項目的接口信息統(tǒng)一導(dǎo)入至postman的一個collection中；
導(dǎo)出所述collection得到一個JSON格式文件，再對所述JSON格式文件進(jìn)行解析，得到每個項目的接口信息。
3.根據(jù)權(quán)利要求1所述的接口文檔自動生成方法，其特征在于，所述利用所述接口信息生成接口文檔，包括：
分析所述接口信息并從所述接口信息中提取項目名稱信息；
根據(jù)所述項目名稱信息創(chuàng)建存儲文件夾，每個項目的所有接口對應(yīng)一個所述存儲文件夾；
利用所述接口信息和Swagger規(guī)范生成每個接口對應(yīng)的接口文檔；
基于所述項目名稱信息將所述接口文檔存儲至對應(yīng)的所述存儲文件夾。
4.根據(jù)權(quán)利要求3所述的接口文檔自動生成方法，其特征在于，所述利用所述接口信息和Swagger規(guī)范生成每個接口對應(yīng)的接口文檔，包括：
將所述接口信息按照預(yù)設(shè)規(guī)則自動轉(zhuǎn)換為所述Swagger規(guī)范規(guī)定格式的參數(shù)；
將所述參數(shù)填充至預(yù)先準(zhǔn)備好的文檔模板中，得到每個接口對應(yīng)的所述接口文檔。
5.根據(jù)權(quán)利要求4所述的接口文檔自動生成方法，其特征在于，所述將所述接口信息按照預(yù)設(shè)規(guī)則自動轉(zhuǎn)換為所述Swagger規(guī)范規(guī)定格式的參數(shù)之后，還包括：
判斷每個接口對應(yīng)的所述參數(shù)中是否包括認(rèn)證參數(shù)；
若不包括，則將所述接口的認(rèn)證參數(shù)設(shè)置為默認(rèn)值并補(bǔ)全至所述參數(shù)中。
6.根據(jù)權(quán)利要求4所述的接口文檔自動生成方法，其特征在于，所述將所述接口信息按照預(yù)設(shè)規(guī)則自動轉(zhuǎn)換為所述Swagger規(guī)范規(guī)定格式的參數(shù)之后，還包括：
判斷每個接口對應(yīng)的所述參數(shù)中是否包括長度超過預(yù)設(shè)閾值的示例；
若包括，則按預(yù)設(shè)截斷規(guī)則將所述示例截斷為至少兩段。
7.根據(jù)權(quán)利要求1所述的接口文檔自動生成方法，其特征在于，所述將域名信息相同的接口文檔進(jìn)行聚合再輸出之后，還包括：
將聚合后的接口文檔上傳至區(qū)塊鏈中。
8.一種接口文檔自動生成系統(tǒng)，其特征在于，包括：
接收模塊，用于接收接口文檔生成請求，所述接口文檔生成請求包括至少一個項目信息；
提取模塊，用于從所述至少一個項目信息中提取出每個項目的接口信息；
分析模塊，用于從所述接口信息中分析出每個接口對應(yīng)的域名信息；
生成模塊，用于利用所述接口信息生成接口文檔；
聚合模塊，用于將域名信息相同的接口文檔進(jìn)行聚合再輸出。
9.一種終端，其特征在于，所述終端包括處理器、與所述處理器耦接的存儲器，其中，
所述存儲器存儲有用于實現(xiàn)如權(quán)利要求1-7中任一項所述的接口文檔自動生成方法的程序指令；
所述處理器用于執(zhí)行所述存儲器存儲的所述程序指令以生成接口文檔且自動聚合。
10.一種存儲介質(zhì)，其特征在于，存儲有能夠?qū)崿F(xiàn)如權(quán)利要求1-7中任一項所述的接口文檔自動生成方法的程序文件。
該專利技術(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/202011073606.X/1.html，轉(zhuǎn)載請聲明來源鉆瓜專利網(wǎng)。
