[發明專利]基于YApi接口文檔自動生成前端頁面的方法

在審

• 申請號: 202111101937.4
• 申請日: 2021-09-18
• 公開（公告）號: CN113778448A
• 公開（公告）日: 2021-12-10
• 發明（設計）人: 鄭廟華
• 申請（專利權）人: 上海中通吉網絡技術有限公司
• 主分類號: G06F8/38
• 分類號: G06F8/38;G06F8/41
• 代理公司: 北京細軟智谷知識產權代理有限責任公司 11471
• 代理人: 葛鐘

本申請涉及一種基于YApi接口文檔自動生成前端頁面的方法，該方法包括：首先將前端代碼中需要與YApi文檔對接的部分用變量和語句替換，生成模板文件；然后通過自定義命令創建目標文件夾，并根據YApi接口文檔分類的ID請求YApi提供的開放接口，獲取接口的信息，經解析后，利用預設模板語法讀取模板文件，將模板文件中變量進行替換，最后在目標文件夾中生成代碼文件。如此，利用現有的代碼創建模板，結合YApi接口文檔，動態生成文件和代碼，完整度高，可直接運行，大大提高前端開發效率。

技術領域

本申請涉及前端技術領域，尤其涉及一種基于YApi接口文檔自動生成前端頁面的方法。

背景技術

當前的前端框架為Vue和React并駕齊驅，兩者成為前后端分離項目前端框架的首選，發展到現在，各種后臺管理系統結構大同小異。通常一個前端項目的結構通常與頁面路由保持一致，在實際應用中，需要根據頁面創建文件夾、文件，大多數成熟的前端項目都會對頁面的組件進行二次封裝，精簡代碼結構，盡量提高編碼的效率。

但是，對于Api文檔相關內容，仍然需要相關工作人員進行重復編輯，無法根據Api文檔生成完整度高可用性強的的代碼，導致在前端開發過程中，工作仍然重復率高，工作量仍然龐大。

發明內容

本申請提供一種基于YApi接口文檔自動生成前端頁面的方法，以解決現有技術中，在進行前端開發時，無法根據Api文檔生成完整度高可用性強的的代碼，導致工作重復率高，工作量龐大的問題。

本申請的上述目的是通過以下技術方案實現的：

本申請實施例提供一種基于YApi接口文檔自動生成前端頁面的方法，包括：

將前端代碼中需要與YApi文檔對接的部分用變量和語句替換，生成模板文件；

創建自定義命令；其中，所述自定義命令中包括需要創建文件夾的名稱以及YApi接口文檔分類ID；

運行所述自定義命令，創建目標文件夾，并根據所述YApi接口文檔分類ID請求YApi提供的開放接口，獲取YApi接口文檔信息；

通過預設模板語法，用所述YApi接口文檔信息替換所述模板文件中的變量，在所述目標文件夾中生成代碼文件。

進一步的，所述需要與YApi文檔對接的部分包括：查詢條件、列表接口名稱、列表表頭和添加編輯頁；

其中，所述查詢條件包括純輸入組件、選擇組件、輸入搜索組件和日期組件；所述添加編輯頁包括模態框表單。

進一步的，所述YApi接口文檔分類ID中的分類包括增刪改查以及導出的接口。

進一步的，所述創建自定義命令包括：

在局部創建自定義命令；

注冊所述自定義命令到全局。

進一步的，所述根據所述YApi接口文檔分類ID請求YApi提供的開放接口，獲取YApi接口文檔信息，包括：

根據所述YApi接口文檔分類ID請求YApi提供的開放接口，再根據返回的api接口集合的id，分別獲取增刪改查的信息。

進一步的，所述通過預設模板語法，用所述YApi接口文檔信息替換所述模板文件中的變量，在所述目標文件夾中生成代碼文件，包括：

解析增刪改查接口返回的信息，構建變量，保存增刪改查導出接口名、查詢接口請求頭配置、查詢接口響應頭配置和新增編輯接口請求配置；

通過預設模板語法，讀取模板文檔內容，解析變量，用所述YApi接口文檔信息進行替換；

在所述目標文件夾中生成經過變量替換的代碼文件。