接口文檔的生成方法及裝置制造方法
【專利摘要】本發(fā)明公開了一種接口文檔的生成方法及裝置，涉及數(shù)據(jù)處理領(lǐng)域，能夠解決接口文檔的編寫費(fèi)時(shí)，編寫效率低的問(wèn)題。所述方法包括：從配置文件中讀取接口文檔信息,所述接口文檔信息用于描述接口程序；生成接口文檔信息的顯示界面；在所述顯示界面中顯示所述接口文檔信息。本發(fā)明主要應(yīng)用于接口文檔維護(hù)與閱讀的過(guò)程中。
【專利說(shuō)明】接口文檔的生成方法及裝置

【技術(shù)領(lǐng)域】
[0001] 本發(fā)明涉及數(shù)據(jù)處理領(lǐng)域，尤其涉及一種接口文檔的生成方法及裝置。

【背景技術(shù)】
[0002] 接口文檔用于描述接口程序的內(nèi)容，例如輸入?yún)?shù)的格式、輸出參數(shù)的格式。如果 只編寫程序不編寫接口文檔，則程序員A編寫的程序很難給程序員B使用。因此程序員除 了編寫程序之外，還需要編寫接口文檔。當(dāng)程序發(fā)生變化時(shí)，程序員根據(jù)輸入?yún)?shù)和輸出參 數(shù)的變化，對(duì)接口文檔進(jìn)行修改，W保證接口文檔的準(zhǔn)確性。
[0003]在實(shí)現(xiàn)上述接口文檔的生成過(guò)程中，發(fā)明人發(fā)現(xiàn)現(xiàn)有技術(shù)中至少存在如下問(wèn)題： 由于接口文檔都是W文本文檔的方式進(jìn)行顯示，因此需要通過(guò)文字編輯工具進(jìn)行接口文檔 的維護(hù)，程序員需要制作表格、根據(jù)接口的協(xié)議構(gòu)造復(fù)雜的例子W保證文檔準(zhǔn)確性，導(dǎo)致編 寫費(fèi)時(shí)，編寫效率低。


【發(fā)明內(nèi)容】

[0004]本發(fā)明提供的一種接口文檔的生成方法及裝置，能夠解決接口文檔的編寫費(fèi)時(shí)， 編寫效率低的問(wèn)題。
[0005]-方面，本發(fā)明提供了一種接口文檔的生成方法，包括：
[0006]從配置文件中讀取接口文檔信息，所述接口文檔信息用于描述接口程序；
[0007]生成接口文檔信息的顯示界面；
[0008]在所述顯示界面中顯示所述接口文檔信息。
[0009]另一方面，本發(fā)明還提供了一種接口文檔的生成裝置，包括：
[0010] 讀取單元，用于從配置文件中讀取接口文檔信息，所述接口文檔信息用于描述接 口程序；
[0011] 生成單元，用于生成所述讀取單元讀取的接口文檔信息的顯示界面；
[0012] 顯示單元，用于在所述生成單元生成的所述顯示界面中顯示所述讀取單元讀取的 所述接口文檔信息。
[0013]本發(fā)明提供的接口文檔的生成方法及裝置，能夠從配置文件中讀取接口文檔信 息，在生成的顯示界面中顯示接口文檔信息?，F(xiàn)有技術(shù)中程序員需要制作表格、根據(jù)接口的 協(xié)議構(gòu)造復(fù)雜的例子W保證文檔準(zhǔn)確性，導(dǎo)致編寫費(fèi)時(shí)，編寫效率低。本發(fā)明中，能夠從配 置文件中自動(dòng)讀取接口文檔信息并在顯示界面中顯示接口文檔信息，無(wú)需程序員對(duì)接口文 檔中的內(nèi)容進(jìn)行識(shí)別，進(jìn)而簡(jiǎn)化接口文檔的編輯，提高接口文檔的維護(hù)效率。

【專利附圖】

【附圖說(shuō)明】
[0014]為了更清楚地說(shuō)明本發(fā)明實(shí)施例或現(xiàn)有技術(shù)中的技術(shù)方案，下面將對(duì)實(shí)施例或現(xiàn) 有技術(shù)描述中所需要使用的附圖作簡(jiǎn)單地介紹，顯而易見地，下面描述中的附圖僅僅是本 發(fā)明的一些實(shí)施例，對(duì)于本領(lǐng)域普通技術(shù)人員來(lái)講，在不付出創(chuàng)造性勞動(dòng)的前提下，還可W 根據(jù)該些附圖獲得其他的附圖。
[0015] 圖1為本發(fā)明實(shí)施例中一個(gè)接口文檔的生成方法的流程圖；
[0016] 圖2為本發(fā)明實(shí)施例中第一個(gè)顯示界面的示意圖；
[0017] 圖3為本發(fā)明實(shí)施例中第二個(gè)顯示界面的示意圖；
[0018] 圖4為本發(fā)明實(shí)施例中第H個(gè)顯示界面的示意圖；
[0019] 圖5為本發(fā)明實(shí)施例中第四個(gè)顯示界面的示意圖；
[0020] 圖6為本發(fā)明實(shí)施例中第五個(gè)顯示界面的示意圖；
[0021] 圖7為本發(fā)明實(shí)施例中配置文件輸入界面的示意圖；
[0022] 圖8為本發(fā)明實(shí)施例中另一個(gè)接口文檔的生成方法的流程圖；
[0023] 圖9為本發(fā)明實(shí)施例中第六個(gè)顯示界面的示意圖；
[0024] 圖10為本發(fā)明實(shí)施例中一個(gè)接口文檔的生成裝置的結(jié)構(gòu)示意圖；
[00巧]圖11為本發(fā)明實(shí)施例中另一個(gè)接口文檔的生成裝置的結(jié)構(gòu)示意圖。

【具體實(shí)施方式】
[0026] 下面將結(jié)合本發(fā)明實(shí)施例中的附圖，對(duì)本發(fā)明實(shí)施例中的技術(shù)方案進(jìn)行清楚、完 整地描述，顯然，所描述的實(shí)施例僅僅是本發(fā)明一部分實(shí)施例，而不是全部的實(shí)施例?；?本發(fā)明中的實(shí)施例，本領(lǐng)域普通技術(shù)人員在沒(méi)有作出創(chuàng)造性勞動(dòng)前提下所獲得的所有其他 實(shí)施例，都屬于本發(fā)明保護(hù)的范圍。
[0027] 本發(fā)明實(shí)施例提供了一種接口文檔的生成方法，所述方法應(yīng)用于存儲(chǔ)有接口程序 的電子設(shè)備中，如存儲(chǔ)有接口程序的服務(wù)器等，如圖1所示，所述方法包括：
[0028] 步驟101、從配置文件中讀取接口文檔信息，接口文檔信息用于描述接口程序。
[0029] 配置文件的記錄有描述接口文檔的接口文檔信息。通過(guò)json數(shù)組承載接口文檔 信息。接口文檔信息包括：接口信息、輸入?yún)?shù)信息、輸出參數(shù)信息、返回碼信息。配置文件 的具體內(nèi)容如表1所示，其中：
[0030] 接口信息包括：接口名稱（intfname)、接口程序描述（describe)。
[0031] 輸入?yún)?shù)信息包括；輸入?yún)?shù)描述（inputDesc)，輸入?yún)?shù)格式模板字符串 (templateStr)W及輸入?yún)?shù)的格式定義字符串（optionalStr)。
[0032] 輸出參數(shù)信息包括；輸出參數(shù)描述（outputDesc)，輸出參數(shù)字符串（outputStr)。
[0033] 返回碼信息包括；返回碼描述（retCodeDesc),返回碼字符串（retCodeStr)。
[0034]表1
[00巧]

【權(quán)利要求】
1. 一種接口文檔的生成方法，其特征在于，包括： 從配置文件中讀取接口文檔信息，所述接口文檔信息用于描述接口程序； 生成接口文檔信息的顯示界面； 在所述顯示界面中顯示所述接口文檔信息。
2. 根據(jù)權(quán)利要求1所述的方法，其特征在于，所述從配置文件中讀取接口文檔信息的 步驟，包括： 從配置文件中讀取接口信息、輸入?yún)?shù)信息、輸出參數(shù)信息、返回碼信息。
3. 根據(jù)權(quán)利要求2所述的方法，其特征在于，所述生成接口文檔信息的顯示界面的步 驟，包括： 生成接口文檔信息的表格形式顯示界面； 或者，生成接口文檔信息的文本框形式顯示界面； 或者，生成接口文檔信息的代碼形式顯示界面。
4. 根據(jù)權(quán)利要求3所述的方法，其特征在于，所述在所述界面中顯示所述接口文檔信 息的步驟，包括： 在所述界面中以遞歸方式分別顯示所述輸入?yún)?shù)信息、輸出參數(shù)信息和返回碼信息。
5. 根據(jù)權(quán)利要求4所述的方法，其特征在于，在所述從配置文件中讀取接口文檔信息 之前，所述方法還包括： 顯示配置文件輸入界面； 接收用戶通過(guò)所述配置文件輸入界面輸入的接口文檔信息。
6. 根據(jù)權(quán)利要求5所述的方法，其特征在于，在所述顯示界面中顯示所述接口文檔信 息之后，所述方法還包括： 接收用戶在所述顯示界面中輸入的更新信息，所述更新信息用于對(duì)已顯示的接口文檔 信息進(jìn)行修改； 將所述更新信息發(fā)送至版本控制服務(wù)器（SVN)，其中，版本控制服務(wù)器對(duì)接口文檔對(duì)應(yīng) 的程序進(jìn)行更新。
7. -種接口文檔的生成裝置，其特征在于，包括： 讀取單元，用于從配置文件中讀取接口文檔信息，所述接口文檔信息用于描述接口程 序； 生成單元，用于生成所述讀取單元讀取的接口文檔信息的顯示界面； 顯示單元，用于在所述生成單元生成的所述顯示界面中顯示所述讀取單元讀取的所述 接口文檔信息。
8. 根據(jù)權(quán)利要求7所述的裝置，其特征在于，所述讀取單元還用于，從配置文件中讀取 接口信息、輸入?yún)?shù)信息、輸出參數(shù)信息、返回碼信息。
9. 根據(jù)權(quán)利要求8所述的裝置，其特征在于，所述生成單元還用于： 生成接口文檔信息的表格形式顯示界面； 或者，生成接口文檔信息的文本框形式顯示界面； 或者，生成接口文檔信息的代碼形式顯示界面。
10. 根據(jù)權(quán)利要求9所述的裝置，其特征在于，所述顯示單元還用于，在所述界面中以 遞歸方式分別顯示所述輸入?yún)?shù)信息、輸出參數(shù)信息和返回碼信息。
11. 根據(jù)權(quán)利要求10所述的裝置，其特征在于， 所述顯示單元還用于，顯示配置文件輸入界面； 所述裝置還包括： 接收單元，用于接收用戶通過(guò)所述顯示單元顯示的所述配置文件輸入界面輸入的接口 文檔信息。
12. 根據(jù)權(quán)利要求11所述的裝置，其特征在于， 所述接收單元還用于，接收用戶在所述顯示界面中輸入的更新信息，所述更新信息用 于對(duì)已顯示的接口文檔信息進(jìn)行修改； 所述裝置包括： 發(fā)送單元，用于將所述更新信息發(fā)送至版本控制服務(wù)器（SVN)，其中，版本控制服務(wù)器 對(duì)接口文檔對(duì)應(yīng)的程序進(jìn)行更新。
【文檔編號(hào)】G06F9/44GK104375814SQ201310354107
【公開日】2015年2月25日 申請(qǐng)日期:2013年8月14日 優(yōu)先權(quán)日:2013年8月14日
【發(fā)明者】李德鎧, 張世維, 李 杰 申請(qǐng)人:騰訊科技（深圳）有限公司