[發明專利]應用程序編程接口使用示例提取方法及裝置

有效

• 申請號: 201110404046.6
• 申請日: 2011-12-07
• 公開（公告）號: CN102567016A
• 公開（公告）日: 2012-07-11
• 發明（設計）人: 王立杰;房路;王樂業;鄒艷珍;趙俊峰
• 申請（專利權）人: 北京北大軟件工程發展有限公司
• 主分類號: G06F9/44
• 分類號: G06F9/44
• 代理公司: 北京同立鈞成知識產權代理有限公司 11205
• 代理人: 劉芳

技術領域

本發明涉及信息技術，尤其涉及一種應用程序編程接口使用示例提取方法及裝置。

背景技術

應用程序編程接口(Application?Programming?Interface，以下簡稱API)使用示例可為用戶學習和使用API函數提供巨大幫助和參考。用戶通常通過互聯網搜索獲得API使用示例，但是由于API使用示例的相關信息往往分散于很多網頁中，為了系統學習該API函數，用戶需要瀏覽大量網頁，這需要消耗大量的時間和精力。

現有技術中為用戶提供一種API使用示例的集合，API使用示例的集合中包含了一定數量的API使用示例以供用戶系統學習。API使用示例的集合大多是基于軟件項目代碼庫提取獲得API使用示例，由于代碼庫中的API使用示例往往和所在軟件項目的業務邏輯緊密交織在一起，從中進行代碼片段的提取比較困難，由此提取出的API使用示例脫離原有上下文，以致用戶難以理解。而且代碼庫中包含的注釋信息比較有限，這些注釋信息一般是對相應業務邏輯的描述和說明，并不是對使用示例的解釋和說明，用戶也很難通過這些注釋作來學習和理解API使用示例，效果不佳。

發明內容

本發明提供一種應用程序編程接口使用示例提取方法及裝置，以提高API使用示例的提取效果。

本發明一個方面提供一種應用程序編程接口使用示例提取方法，包括：

獲取包含有應用程序編程接口API檢索信息的網頁；

從所述網頁中提取API代碼段

從所述網頁中提取所述API代碼段對應的文本描述信息；

將所述API代碼段和所述API代碼段對應的文本描述信息組合成為API使用示例。

本發明另一個方面提供一種應用程序編程接口使用示例提取裝置，包括：

頁面獲取模塊，用于獲取包含有應用程序編程接口API檢索信息的網頁；

代碼段提取模塊，用于從所述網頁中提取API代碼段；

描述信息提取模塊，用于從所述網頁中提取所述API代碼段對應的文本描述信息；

使用示例生成模塊，用于將所述API代碼段和所述API代碼段對應的文本描述信息組合成為API使用示例。

由上述技術方案可知，本發明提供的應用程序編程接口使用示例提取方法及裝置，獲取包含有API檢索信息的網頁，從網頁中提取API代碼段和API代碼段對應的文本描述信息，將API代碼段和API代碼段對應的文本描述信息組合成為API使用示例，由于提取得到的API使用示例既包含API代碼段又包含用于對該API代碼段解釋的文本描述信息，而且API使用示例是從網頁中提取的，不需要專門獲取代碼庫，提高了API使用示例的提取效果。

附圖說明

圖1為本發明實施例一提供的應用程序編程接口使用示例提取方法流程圖；

圖2為本發明實施例二提供的應用程序編程接口使用示例提取方法流程圖；

圖3為本發明實施例三提供的應用程序編程接口使用示例提取裝置結構示意圖；

圖4為本發明實施例四提供的應用程序編程接口使用示例提取裝置結構示意圖。

具體實施方式

實施例一

圖1為本發明實施例一提供的應用程序編程接口使用示例提取方法流程圖。如圖1所示，本實施例提供的應用程序編程接口使用示例提取方法具體可以應用于對應用程序編程接口API使用示例的提取過程，尤其是Java?API使用示例的提取過程，可以通過API使用示例提取裝置來執行。

本實施例提供的應用程序編程接口使用示例提取方法具體包括：

步驟10、獲取包含有API檢索信息的網頁；

具體地，可以通過搜索引擎收集包含有API檢索信息的網頁，API檢索信息具體為用以檢索API使用示例的關鍵詞，可以為API函數的名稱，例如“API_FQN”，如example、java等關鍵詞。“API_FQN”可以用于限定API使用示例的名稱，API_FQN兩端的雙引號用于要求搜索引擎不對其切詞，example和java可以用于限定查詢范圍。通過搜索引擎進行檢索，將搜索得到的網頁保存，具體可以保存檢索結果中排在前N個的網頁進行保存，N為預設網頁數值，例如N＝300，N的值可以根據實際的網頁分析需要來具體設置，不以本實施例為限。

步驟20、從網頁中提取API代碼段；

步驟30、從網頁中提取API代碼段對應的文本描述信息；

步驟40、將API代碼段和API代碼段對應的文本描述信息組合成為API使用示例。