[發明專利]接口文件解析方法和裝置

在審

• 申請號: 201610676367.4
• 申請日: 2016-08-16
• 公開（公告）號: CN107766083A
• 公開（公告）日: 2018-03-06
• 發明（設計）人: 陳瓏
• 申請（專利權）人: 中興通訊股份有限公司
• 主分類號: G06F9/44
• 分類號: G06F9/44
• 代理公司: 廣東廣和律師事務所44298
• 代理人: 章小燕

技術領域

本發明涉及數據處理技術領域，尤其涉及一種接口文件解析方法和裝置。

背景技術

在通常的項目管理中,對接口文檔(例如restful類型接口文件)的管理相當的繁瑣，需根據不同的領域進行劃分。在開發的過程中往往又伴隨著接口的變更、刪除和添加操作，因此在維護API接口的同時,需要維護API接口文檔,在時間成本和人力成本上有了大大的支出。

另外不同的產品可能發布不同的API接口，因而要在日常維護的接口文檔全集中篩選出本次發布的版本/產品中需要對外提供的接口信息,以免造成接口泄露/后門漏洞等一系列影響到信息安全以及相關知識產權的問題，對版本管理也是一大負擔。

一般接口文件屬于閱讀型文檔,用戶在調用接口時,需要去尋找該接口所在文檔的位置,并完全了解其實際請求頭和body(正文)結構。而開發人員每開發一個接口,就需要去更新相應的接口文檔,并需要完全按照相關文件類型的語法進行注解,才能呈現給用戶一個可閱讀而不可操作的文檔輸出。

發明內容

有鑒于此，本發明的目的在于提供一種接口文件解析方法和裝置,以克服用戶在調用接口時需要自行查閱接口文檔的問題。

本發明解決上述技術問題所采用的技術方案如下：

根據本發明的一個方面，提供的一種接口文件解析方法，包括：接收用戶對接口的調用請求；從所述接口對應的接口文件中，獲取所述接口對應的一個或多個接口元素；將所述一個或多個接口元素導出到文檔中，以展示給所述用戶。

可選地，前述的方法，所述接口文件中預設有與所述一個或多個接口元素中的至少一個接口元素對應的注解信息；所述方法還包括：將所述注解信息導出到所述文檔中，以展示給所述用戶。

可選地，前述的方法，所述至少一個接口元素包括：所述接口的返回值，以及所述接口的所需參數和/或請求首部。

可選地，前述的方法，所述接口文件中預設有與所述接口對應的標識信息；在從所述接口對應的接口文件中，獲取所述接口對應的一個或多個接口元素之前，包括：根據所述標識信息從所述接口文件中查找所述接口。

可選地，前述的方法，將所述一個或多個接口元素導出到文檔中，具體包括：按預設的導出路徑導出所述文檔。

可選地，前述的方法，還包括：接收所述用戶對所述文檔中的任一接口元素的操作請求；對所述任一接口元素執行所述操作請求對應的操作。

根據本發明的另一方面，提供的一種接口文件解析裝置，包括：調用請求接收模塊，用于接收用戶對接口的調用請求；接口元素獲取模塊，用于從所述接口對應的接口文件中，獲取所述接口對應的一個或多個接口元素；文檔導出模塊，用于將所述一個或多個接口元素導出到文檔中，以展示給所述用戶。

可選地，前述的裝置，所述接口文件中預設有與所述一個或多個接口元素中的至少一個接口元素對應的注解信息；所述文檔導出模塊將所述注解信息導出到所述文檔中，以展示給所述用戶。

可選地，前述的裝置，所述至少一個接口元素包括：所述接口的返回值，以及所述接口的所需參數和/或請求首部。

可選地，前述的裝置，所述接口文件中預設有與所述接口對應的標識信息；所述裝置還包括：接口查找模塊，用于根據所述標識信息從所述接口文件中查找所述接口。

可選地，前述的裝置，所述文檔導出模塊按預設的導出路徑導出所述文檔。

可選地，前述的裝置，還包括：操作請求接收模塊，用于接收所述用戶對所述文檔中的任一接口元素的操作請求；操作模塊，用于對所述任一接口元素執行所述操作請求對應的操作。

根據以上技術方案，可知本發明的接口文件解析方法和裝置至少具有以下優點：

根據本發明的技術方案，用戶在進行接口調用時，不再需要自行閱讀接口文檔并從中查找該接口的相關內容，而是自動為用戶呈現所需調用接口的相關接口元素，使得用戶對該接口的相關元素有所了解，有利于快速完成對接口的調用，相比于現有技術方案節省了時間提高了效率。

附圖說明

圖1為本發明實施例的一種接口文件解析方法的流程圖；

圖2為本發明實施例的一種接口文件解析方法的流程圖；

圖3為本發明實施例的一種接口文件解析裝置的框圖；

圖4為本發明實施例的一種接口文件解析裝置的框圖。

本發明目的的實現、功能特點及優點將結合實施例，參照附圖做進一步說明。

具體實施方式