[發明專利]一種掃描接口并生成可調用API接口文檔的方法

在審

• 申請號: 201810636083.1
• 申請日: 2018-06-20
• 公開（公告）號: CN108804103A
• 公開（公告）日: 2018-11-13
• 發明（設計）人: 張松;陳小天
• 申請（專利權）人: 鄭州云海信息技術有限公司
• 主分類號: G06F8/38
• 分類號: G06F8/38
• 代理公司: 濟南舜源專利事務所有限公司 37205
• 代理人: 張渲

本發明涉及一種掃描接口并生成可調用API接口文檔的方法，其特征在于，包括以下步驟：S1：掃描接口文件中的全部接口以及接口信息，并將接口信息進行存儲；S2：生成Postman工具的功能界面，讀取步驟S1中掃描到的數據，并填充接口調用需要的參數；S3：生成直接調用的API接口文檔。

技術領域

本發明屬于JavaWeb開發技術領域，涉及一種API接口文檔的生成方法，尤其是一種掃描接口并生成可調用API接口文檔的方法。

背景技術

API（Application Programming Interface,應用程序編程接口）是一些預先定義的函數，目的是提供應用程序與開發人員基于某軟件或硬件得以訪問一組例程的能力，而又無需訪問源碼，或理解內部工作機制的細節。

API函數包含在Windows系統目錄下的動態連接庫文件中。Windows API是一套用來控制Windows的各個部件的外觀和行為的預先定義的Windows函數。用戶的每個動作都會引發一個或幾個函數的運行以告訴Windows發生了什么。這在某種程度上很像Windows的天然代碼。而其他的語言只是提供一種能自動而且更容易的訪問API的方法。當你點擊窗體上的一個按鈕時，Windows會發送一個消息給窗體，VB獲取這個調用并經過分析后生成一個特定事件。

更易理解來說：Windows系統除了協調應用程序的執行、內存的分配、系統資源的管理外，同時他也是一個很大的服務中心。調用這個服務中心的各種服務(每一種服務就是一個函數)可以幫助應用程序達到開啟視窗、描繪圖形和使用周邊設備等目的，由于這些函數服務的對象是應用程序，所以稱之為Application Programming Interface，簡稱API 函數。WIN32 API也就是MicrosoftWindows 32位平臺的應用程序編程接口。

凡是在 Windows工作環境底下執行的應用程序，都可以調用Windows API。

在linux中，用戶編程接口API遵循了UNIX中最流行的應用編程界面標準---POSIX標準。POSIX標準是由IEEE和ISO/IEC共同開發的標準系統。該標準基于當時現有的UNIX實踐和經驗，描述了操作系統的系統調用編程接口API，用于保證應用程序可以在源程序一級上在多種操作系統上移植運行。這些系統調用編程接口主要是通過C庫（LIBC）來實現的。

基于互聯網的應用正變得越來越普及，在這個過程中，有更多的站點將自身的資源開放給開發者來調用。對外提供的API 調用使得站點之間的內容關聯性更強，同時這些開放的平臺也為用戶、開發者和中小網站帶來了更大的價值。

開放是目前的發展趨勢，越來越多的產品走向開放。目前的網站不能靠限制用戶離開來留住用戶，開放的架構反而更增加了用戶的粘性。在Web 2.0的浪潮到來之前，開放的API 甚至源代碼主要體現在桌面應用上，而現在越來越多的Web應用面向開發者開放了API。

傳統JavaWeb開發中，需要接口的開發人員在Postman等工具中手動添加，才能生成相關的API接口文檔。并且共享和更新都需要手動維護，非常影響開發人員的工作效率。此為現有技術的不足之處。

因此，針對現有技術中的上述缺陷，提供設計一種掃描接口并生成可調用API接口文檔的方法；以解決現有技術中的上述缺陷，是非常有必要的。

發明內容

本發明的目的在于，針對上述現有技術存在的缺陷，提供設計一種掃描接口并生成可調用API接口文檔的方法，以解決上述技術問題。

為實現上述目的，本發明給出以下技術方案：

一種掃描接口并生成可調用API接口文檔的方法，其特征在于，包括以下步驟：

S1：掃描接口文件中的全部接口以及接口信息，并將接口信息進行存儲；