[發明專利]生成展示接口文檔的系統、方法及介質

有效

• 申請號: 202110255762.6
• 申請日: 2021-03-09
• 公開（公告）號: CN112926290B
• 公開（公告）日: 2023-04-07
• 發明（設計）人: 鄧志遠
• 申請（專利權）人: 上海萬向區塊鏈股份公司
• 主分類號: G06F40/166
• 分類號: G06F40/166;G06F40/14
• 代理公司: 上海段和段律師事務所 31334
• 代理人: 李佳俊;郭國中

本發明提供了一種生成展示接口文檔的系統、方法及介質，包括：數據解析模塊：將全量數據依據數據之間的聯系進行解析拆分，同時過濾掉預設范圍內的重復數據；數據展示模塊：在界面編輯參數示例發送接口請求并展示相應數據；文檔導出模塊：生成所需項目的接口文檔并導出，導出的接口文檔內容格式根據需求進行設置編輯。本發明解決了當前不同項目接口文檔不能統一觀看、數據展示交互不友好、不可版本對比等問題，本發明可以瀏覽不同項目的接口文檔、并且導出不同格式的文檔，還能進行接口文檔的歷史版本對比、接口調用測試。

技術領域

本發明涉及計算機應用技術領域，具體地，涉及一種生成展示接口文檔的系統、方法及介質。

背景技術

當前技術條件下大多數接口文檔一部分是通過方式一：服務端配置一些生成文檔的插件，設置一些參數啟動服務后會輸出一個文檔地址，一部分是通過方式二：服務器獲取腳本對象符號形式的接口文檔，對腳本對象符號形式的接口文檔進行解析，并將解析得到的接口表，封裝成表格實體，得到文字形式的接口文檔。兩種方式都有相同的一些問題，例如：具有局限性，展示數據不完整，展示效果不好，交互方式不友好，也無法拓展新的功能。方式一生成的文檔地址還會收到相關環境的ip與端口影響，前端開發人員會需要依據不同項目、不同環境打開不同的頁面查看接口文檔，并且無法提供對外輸出所需的文檔。方式二問題在于生成的表格形式的接口數據，不夠直觀，也沒有能夠在線調用接口調試的功能，功能較為單一。

當前技術條件下接口文檔通常都是展示最新版本的接口，查看不同版本的接口信息改動需要開發人員手動打開不同版本接口文檔進行人工比對。

一般一些對外的接口文檔需要開發人員手動編寫，相應的介紹與目錄。

專利文獻CN110941950A(申請號：CN201911179920.3)公開了接口文檔的生成方法、裝置、服務器及存儲介質。該系統存在以下弊端：(1)此發明對數據處理略顯復雜，且轉換流程較多較為復雜。(2)此發明沒有良好的拓展性，難以進行更多功能的定制開發，后續維護性較低。(3)只能得到靜態的接口信息，無法在線調用調試。(4)無法輸出markdown形式接口文檔。(5)數據展示不友好，不直觀且不支持新舊版本文檔對比與展示。

發明內容

針對現有技術中的缺陷，本發明的目的是提供一種生成展示接口文檔的系統、方法及介質。

根據本發明提供的生成展示接口文檔的系統，包括：

數據解析模塊：將全量數據依據數據之間的聯系進行解析拆分，同時過濾掉預設范圍內的重復數據；

數據展示模塊：在界面編輯參數示例發送接口請求并展示相應數據；

文檔導出模塊：生成所需項目的接口文檔并導出，導出的接口文檔內容格式根據需求進行設置編輯。

優選的，不同項目數據形式不同，對應的解析方式也不同，根據項目類型進行解析；

同時展示新舊版本的接口相關數據信息，并進行數據對比。

優選的，通過接口請求得到全量項目列表后，通過對應項目名稱發送請求獲取到該項目的全量數據，通過遍歷數據獲取項目名稱、項目版本、項目簡介、項目部署的ip與端口以及項目包含的全量接口數據，通過遍歷接口的數據將全量的接口名稱與路徑匹配到對應模塊。

優選的，設置項目和接口數據的格式，分別與項目主頁和接口數據展示頁面進行綁定，通過解析出的數據中的模塊數據在頁面中展示對應的菜單，通過所選菜單跳轉對應主頁，通過點擊菜單欄子項接口名跳轉到對應接口詳情頁。

根據本發明提供的生成展示接口文檔的方法，包括：

數據解析步驟：將全量數據依據數據之間的聯系進行解析拆分，同時過濾掉預設范圍內的重復數據；

數據展示步驟：在界面編輯參數示例發送接口請求并展示相應數據；