[發明專利]文檔生成方法、系統、設備及可讀存儲介質

在審

• 申請號: 202110567072.4
• 申請日: 2021-05-24
• 公開（公告）號: CN113296785A
• 公開（公告）日: 2021-08-24
• 發明（設計）人: 盧俊杰
• 申請（專利權）人: 平安養老保險股份有限公司
• 主分類號: G06F8/41
• 分類號: G06F8/41;G06F8/73
• 代理公司: 北京英特普羅知識產權代理有限公司 11015
• 代理人: 鄧小玲

本發明公開了一種文檔生成方法，包括：獲取預設開發框架中的處理器類；通過預設的方法解析器對所述處理器類中的各個所述方法進行解析，生成所述應用程序接口的注解集及數據集；通過所述預設開發框架中的應用程序接口解析器對各個所述應用程序接口對應的注解信息及數據信息進行解析，并將提取出的各個所述應用程序接口對應的第一應用程序接口信息及第二應用程序接口信息進行組合，得到各個所述應用程序接口對應的目標接口信息；將各個所述應用程序接口對應的目標接口信息按照預設格式進行序列化，生成應用程序接口文檔。本發明實施例使開源產品能夠適配使用現有的開發框架進行應用程序接口加載管理，同時正確生成對應的應用程序接口文檔。

技術領域

本發明涉及軟件開發領域，具體涉及一種文檔生成方法、系統、設備及可讀存儲介質。

背景技術

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

API文檔是一個關于API的技術內容交付文件，包含如何有效地使用和集成API的說明。它是一個簡明的參考手冊，包含了使用API所需的所有信息，詳細介紹了函數、類、返回類型、參數等。

傳統的Swagger API文檔生成方法可以是人工進行Swagger API文檔的編寫，或者基于SpringMVC3.1之后的版本所對應的系統進行開發生成，其中，Swagger是一個規范且完整的框架，用于生成、描述、調用和可視化RESTful風格的Web服務。

然而，針對上述做法，發明人發現，傳統的Swagger API文檔生成方法由于SpringMVC3.1之后的版本對整個內存對象做了重大變更，與之前的版本差異很大，導致開源產品均無法適配使用HandlerMapping接口的實現類，比如類DefaultAnnotationHandlerMapping，進行API加載管理，使系統無法正確生成對應的Swagger API文檔。

發明內容

本發明的目的在于提供一種文檔生成方法、系統、計算機設備及可讀存儲介質，用于解決現有技術中基于SpringMVC3.1之后的版本所對應的系統進行開發時，開源產品均無法適配使用HandlerMapping接口的實現類進行API加載管理，使系統無法正確生成對應的Swagger API文檔的缺陷。

根據本發明的一個方面，提供了一種文檔生成方法，該方法包括如下步驟：

獲取預設開發框架中的處理器類，其中，所述處理器類包括一個或多個方法，所述方法包括一個或多個應用程序接口；

通過預設的方法解析器對所述處理器類中的各個所述方法進行解析，生成各個所述應用程序接口的注解集及數據集，所述注解集包括各個所述應用程序接口對應的注解信息，所述數據集包括各個所述應用程序接口對應的數據信息；

通過所述預設開發框架中的應用程序接口解析器對各個所述應用程序接口對應的注解信息及數據信息進行解析，以提取出各個所述應用程序接口對應的第一應用程序接口信息及第二應用程序接口信息；

將所述第一應用程序接口信息及所述第二應用程序接口信息進行組合，得到各個所述應用程序接口對應的目標接口信息；

將各個所述應用程序接口對應的目標接口信息按照預設格式進行序列化，生成應用程序接口文檔。

可選地，所述應用程序接口解析器包括第一應用程序接口解析器，所述第一應用程序接口信息包括第一目標接口信息，所述通過所述預設開發框架中的應用程序接口解析器對各個所述應用程序接口對應的注解信息及數據信息進行解析，以提取出各個所述應用程序接口對應的第一應用程序接口信息，包括：