接口文檔的生成方法及裝置製造方法
2023-04-23 23:45:36 3
接口文檔的生成方法及裝置製造方法
【專利摘要】本發明公開了一種接口文檔的生成方法及裝置，涉及數據處理領域，能夠解決接口文檔的編寫費時，編寫效率低的問題。所述方法包括：從配置文件中讀取接口文檔信息,所述接口文檔信息用於描述接口程序；生成接口文檔信息的顯示界面；在所述顯示界面中顯示所述接口文檔信息。本發明主要應用於接口文檔維護與閱讀的過程中。
【專利說明】接口文檔的生成方法及裝置
【技術領域】
[0001] 本發明涉及數據處理領域，尤其涉及一種接口文檔的生成方法及裝置。
【背景技術】
[0002] 接口文檔用於描述接口程序的內容，例如輸入參數的格式、輸出參數的格式。如果 只編寫程序不編寫接口文檔，則程式設計師A編寫的程序很難給程式設計師B使用。因此程式設計師除 了編寫程序之外，還需要編寫接口文檔。當程序發生變化時，程式設計師根據輸入參數和輸出參 數的變化，對接口文檔進行修改，W保證接口文檔的準確性。
[0003]在實現上述接口文檔的生成過程中，發明人發現現有技術中至少存在如下問題： 由於接口文檔都是W文本文檔的方式進行顯示，因此需要通過文字編輯工具進行接口文檔 的維護，程式設計師需要製作表格、根據接口的協議構造複雜的例子W保證文檔準確性，導致編 寫費時，編寫效率低。
【發明內容】
[0004]本發明提供的一種接口文檔的生成方法及裝置，能夠解決接口文檔的編寫費時， 編寫效率低的問題。
[0005]-方面，本發明提供了一種接口文檔的生成方法，包括：
[0006]從配置文件中讀取接口文檔信息，所述接口文檔信息用於描述接口程序；
[0007]生成接口文檔信息的顯示界面；
[0008]在所述顯示界面中顯示所述接口文檔信息。
[0009]另一方面，本發明還提供了一種接口文檔的生成裝置，包括：
[0010] 讀取單元，用於從配置文件中讀取接口文檔信息，所述接口文檔信息用於描述接 口程序；
[0011] 生成單元，用於生成所述讀取單元讀取的接口文檔信息的顯示界面；
[0012] 顯示單元，用於在所述生成單元生成的所述顯示界面中顯示所述讀取單元讀取的 所述接口文檔信息。
[0013]本發明提供的接口文檔的生成方法及裝置，能夠從配置文件中讀取接口文檔信 息，在生成的顯示界面中顯示接口文檔信息。現有技術中程式設計師需要製作表格、根據接口的 協議構造複雜的例子W保證文檔準確性，導致編寫費時，編寫效率低。本發明中，能夠從配 置文件中自動讀取接口文檔信息並在顯示界面中顯示接口文檔信息，無需程式設計師對接口文 檔中的內容進行識別，進而簡化接口文檔的編輯，提高接口文檔的維護效率。
【專利附圖】
【附圖說明】
[0014]為了更清楚地說明本發明實施例或現有技術中的技術方案，下面將對實施例或現 有技術描述中所需要使用的附圖作簡單地介紹，顯而易見地，下面描述中的附圖僅僅是本 發明的一些實施例，對於本領域普通技術人員來講，在不付出創造性勞動的前提下，還可W 根據該些附圖獲得其他的附圖。
[0015] 圖1為本發明實施例中一個接口文檔的生成方法的流程圖；
[0016] 圖2為本發明實施例中第一個顯示界面的示意圖；
[0017] 圖3為本發明實施例中第二個顯示界面的示意圖；
[0018] 圖4為本發明實施例中第H個顯示界面的示意圖；
[0019] 圖5為本發明實施例中第四個顯示界面的示意圖；
[0020] 圖6為本發明實施例中第五個顯示界面的示意圖；
[0021] 圖7為本發明實施例中配置文件輸入界面的示意圖；
[0022] 圖8為本發明實施例中另一個接口文檔的生成方法的流程圖；
[0023] 圖9為本發明實施例中第六個顯示界面的示意圖；
[0024] 圖10為本發明實施例中一個接口文檔的生成裝置的結構示意圖；
[00巧]圖11為本發明實施例中另一個接口文檔的生成裝置的結構示意圖。
【具體實施方式】
[0026] 下面將結合本發明實施例中的附圖，對本發明實施例中的技術方案進行清楚、完 整地描述，顯然，所描述的實施例僅僅是本發明一部分實施例，而不是全部的實施例。基於 本發明中的實施例，本領域普通技術人員在沒有作出創造性勞動前提下所獲得的所有其他 實施例，都屬於本發明保護的範圍。
[0027] 本發明實施例提供了一種接口文檔的生成方法，所述方法應用於存儲有接口程序 的電子設備中，如存儲有接口程序的伺服器等，如圖1所示，所述方法包括：
[0028] 步驟101、從配置文件中讀取接口文檔信息，接口文檔信息用於描述接口程序。
[0029] 配置文件的記錄有描述接口文檔的接口文檔信息。通過json數組承載接口文檔 信息。接口文檔信息包括：接口信息、輸入參數信息、輸出參數信息、返回碼信息。配置文件 的具體內容如表1所示，其中：
[0030] 接口信息包括：接口名稱（intfname)、接口程序描述（describe)。
[0031] 輸入參數信息包括；輸入參數描述（inputDesc)，輸入參數格式模板字符串 (templateStr)W及輸入參數的格式定義字符串（optionalStr)。
[0032] 輸出參數信息包括；輸出參數描述（outputDesc)，輸出參數字符串（outputStr)。
[0033] 返回碼信息包括；返回碼描述（retCodeDesc),返回碼字符串（retCodeStr)。
[0034]表1
[00巧]
【權利要求】
1. 一種接口文檔的生成方法，其特徵在於，包括： 從配置文件中讀取接口文檔信息，所述接口文檔信息用於描述接口程序； 生成接口文檔信息的顯示界面； 在所述顯示界面中顯示所述接口文檔信息。
2. 根據權利要求1所述的方法，其特徵在於，所述從配置文件中讀取接口文檔信息的 步驟，包括： 從配置文件中讀取接口信息、輸入參數信息、輸出參數信息、返回碼信息。
3. 根據權利要求2所述的方法，其特徵在於，所述生成接口文檔信息的顯示界面的步 驟，包括： 生成接口文檔信息的表格形式顯示界面； 或者，生成接口文檔信息的文本框形式顯示界面； 或者，生成接口文檔信息的代碼形式顯示界面。
4. 根據權利要求3所述的方法，其特徵在於，所述在所述界面中顯示所述接口文檔信 息的步驟，包括： 在所述界面中以遞歸方式分別顯示所述輸入參數信息、輸出參數信息和返回碼信息。
5. 根據權利要求4所述的方法，其特徵在於，在所述從配置文件中讀取接口文檔信息 之前，所述方法還包括： 顯示配置文件輸入界面； 接收用戶通過所述配置文件輸入界面輸入的接口文檔信息。
6. 根據權利要求5所述的方法，其特徵在於，在所述顯示界面中顯示所述接口文檔信 息之後，所述方法還包括： 接收用戶在所述顯示界面中輸入的更新信息，所述更新信息用於對已顯示的接口文檔 信息進行修改； 將所述更新信息發送至版本控制伺服器（SVN)，其中，版本控制伺服器對接口文檔對應 的程序進行更新。
7. -種接口文檔的生成裝置，其特徵在於，包括： 讀取單元，用於從配置文件中讀取接口文檔信息，所述接口文檔信息用於描述接口程 序； 生成單元，用於生成所述讀取單元讀取的接口文檔信息的顯示界面； 顯示單元，用於在所述生成單元生成的所述顯示界面中顯示所述讀取單元讀取的所述 接口文檔信息。
8. 根據權利要求7所述的裝置，其特徵在於，所述讀取單元還用於，從配置文件中讀取 接口信息、輸入參數信息、輸出參數信息、返回碼信息。
9. 根據權利要求8所述的裝置，其特徵在於，所述生成單元還用於： 生成接口文檔信息的表格形式顯示界面； 或者，生成接口文檔信息的文本框形式顯示界面； 或者，生成接口文檔信息的代碼形式顯示界面。
10. 根據權利要求9所述的裝置，其特徵在於，所述顯示單元還用於，在所述界面中以 遞歸方式分別顯示所述輸入參數信息、輸出參數信息和返回碼信息。
11. 根據權利要求10所述的裝置，其特徵在於， 所述顯示單元還用於，顯示配置文件輸入界面； 所述裝置還包括： 接收單元，用於接收用戶通過所述顯示單元顯示的所述配置文件輸入界面輸入的接口 文檔信息。
12. 根據權利要求11所述的裝置，其特徵在於， 所述接收單元還用於，接收用戶在所述顯示界面中輸入的更新信息，所述更新信息用 於對已顯示的接口文檔信息進行修改； 所述裝置包括： 發送單元，用於將所述更新信息發送至版本控制伺服器（SVN)，其中，版本控制伺服器 對接口文檔對應的程序進行更新。
【文檔編號】G06F9/44GK104375814SQ201310354107
【公開日】2015年2月25日 申請日期:2013年8月14日 優先權日:2013年8月14日
【發明者】李德鎧, 張世維, 李 傑 申請人:騰訊科技（深圳）有限公司