[發(fā)明專利]生成接口描述文件的方法、裝置、設備及可讀存儲介質(zhì)

有效

• 申請?zhí)枺?/td>: 201911060384.5
• 申請日: 2019-11-01
• 公開（公告）號: CN110795084B
• 公開（公告）日: 2021-08-27
• 發(fā)明（設計）人: 王毅;張志歡;楚正
• 申請（專利權(quán)）人: 騰訊科技（深圳）有限公司
• 主分類號: G06F8/30
• 分類號: G06F8/30;G06F16/25
• 代理公司: 北京市立方律師事務所 11330
• 代理人: 張筱寧

本申請實施例提供了一種生成接口描述文件的方法、裝置、設備及可讀存儲介質(zhì)，該方法包括：接收第一設備發(fā)送的超文本傳輸協(xié)議HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)；將HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)進行匯總分組處理，得到第一接口定義數(shù)據(jù)；根據(jù)第一接口定義數(shù)據(jù)，將HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)進行大數(shù)據(jù)分析，得到第二接口定義數(shù)據(jù)；根據(jù)所述第二接口定義數(shù)據(jù)和預設的接口描述文件的格式，生成所述接口描述文件。該方法實現(xiàn)了不需要前提依賴，通過對HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)的分析，生成接口描述文件；該方法與開發(fā)語言無關，與運行環(huán)境無關，不需要嚴格的代碼開發(fā)規(guī)范，易用性和實用性極大地提升，不會增加開發(fā)的工作量，不會對現(xiàn)有接口服務增加任何要求和工作量。

技術領域

本申請涉及計算機技術領域，具體而言，本申請涉及一種生成接口描述文件的方法、裝置、設備及可讀存儲介質(zhì)。

背景技術

現(xiàn)有技術中生成接口描述文件的方式都有明顯的前提依賴，例如，前提依賴包括已有規(guī)范化的代碼、Javadoc文件或定制化的配置文件，這些前提依賴都是需要有非常良好的開發(fā)習慣和規(guī)范支持，例如，規(guī)范的代碼編寫和結(jié)構(gòu)，清晰的注釋等?，F(xiàn)有技術中生成接口描述文件的方式對開發(fā)人員的要求更高，最終生成接口描述文件的效果也會因此大打折扣，例如，多語言的支持不夠，配置文件的格式限制等。

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

本申請針對現(xiàn)有的方式的缺點，提出一種生成接口描述文件的方法、裝置、電子設備及計算機可讀存儲介質(zhì)，用以解決如何無需前提依賴就能生成接口描述文件的問題。

第一方面，本申請?zhí)峁┝艘环N生成接口描述文件的方法，應用于服務器，包括：

接收第一設備發(fā)送的超文本傳輸協(xié)議HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)；

將HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)進行匯總分組處理，得到第一接口定義數(shù)據(jù)；

根據(jù)第一接口定義數(shù)據(jù)，將HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)進行大數(shù)據(jù)分析，得到第二接口定義數(shù)據(jù)；

根據(jù)第二接口定義數(shù)據(jù)和預設的接口描述文件的格式，生成接口描述文件。

可選地，第一設備包括應用程序接口API網(wǎng)關、網(wǎng)頁服務器Web Server中的至少一項，第一設備用于接收客戶端發(fā)送的HTTP請求以及根據(jù)HTTP請求獲取HTTP請求對應的HTTP請求數(shù)據(jù)，第一設備還用于發(fā)送HTTP響應給客戶端以及根據(jù)HTTP響應獲取HTTP響應對應的HTTP響應數(shù)據(jù)。

可選地，第一接口定義數(shù)據(jù)包括以下至少一項：

域名、接口路徑、請求方法、參數(shù)、請求頭、請求內(nèi)容體、響應碼、響應頭、響應內(nèi)容體。

可選地，將HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)進行匯總分組處理，得到第一接口定義數(shù)據(jù)，包括：

將HTTP請求數(shù)據(jù)和HTTP響應數(shù)據(jù)中相同的域名的數(shù)據(jù)匯總到同一個多維數(shù)據(jù)分組中的第一層級；

將第一層級中相同的接口路徑的數(shù)據(jù)匯總到同一個多維數(shù)據(jù)分組中的第二層級；

將第二層級中相同的請求方法的數(shù)據(jù)匯總到同一個多維數(shù)據(jù)分組中的第三層級；

根據(jù)所述請求方法，得到所述同一個多維數(shù)據(jù)分組中的第四層級中的數(shù)據(jù)，第四層級中的數(shù)據(jù)包括參數(shù)、請求頭、請求內(nèi)容體、響應碼中的至少一項；

根據(jù)域名、接口路徑、請求方法和第四層級中的數(shù)據(jù)，得到第一接口定義數(shù)據(jù)，同一個多維數(shù)據(jù)分組包括第一接口定義數(shù)據(jù)的結(jié)構(gòu)。

可選地，當?shù)谒膶蛹壷械臄?shù)據(jù)包括響應碼，方法還包括：

將第四層級中相同的響應碼的數(shù)據(jù)匯總到同一個多維數(shù)據(jù)分組中的第五層級，第五層級中的數(shù)據(jù)包括響應頭、響應內(nèi)容體中的至少一項。