[發明專利]接口文檔的生成方法及裝置

在審

• 申請號: 201310354107.1
• 申請日: 2013-08-14
• 公開（公告）號: CN104375814A
• 公開（公告）日: 2015-02-25
• 發明（設計）人: 李德鎧;張世維;李杰
• 申請（專利權）人: 騰訊科技（深圳）有限公司
• 主分類號: G06F9/44
• 分類號: G06F9/44
• 代理公司: 北京中博世達專利商標代理有限公司 11274
• 代理人: 申健

1.一種接口文檔的生成方法，其特征在于，包括：

從配置文件中讀取接口文檔信息,所述接口文檔信息用于描述接口程序；

生成接口文檔信息的顯示界面；

在所述顯示界面中顯示所述接口文檔信息。

2.根據權利要求1所述的方法，其特征在于，所述從配置文件中讀取接口文檔信息的步驟，包括：

從配置文件中讀取接口信息、輸入參數信息、輸出參數信息、返回碼信息。

3.根據權利要求2所述的方法，其特征在于，所述生成接口文檔信息的顯示界面的步驟，包括：

生成接口文檔信息的表格形式顯示界面；

或者，生成接口文檔信息的文本框形式顯示界面；

或者，生成接口文檔信息的代碼形式顯示界面。

4.根據權利要求3所述的方法，其特征在于，所述在所述界面中顯示所述接口文檔信息的步驟，包括：

在所述界面中以遞歸方式分別顯示所述輸入參數信息、輸出參數信息和返回碼信息。

5.根據權利要求4所述的方法，其特征在于，在所述從配置文件中讀取接口文檔信息之前，所述方法還包括：

顯示配置文件輸入界面；

接收用戶通過所述配置文件輸入界面輸入的接口文檔信息。

6.根據權利要求5所述的方法，其特征在于，在所述顯示界面中顯示所述接口文檔信息之后，所述方法還包括：

接收用戶在所述顯示界面中輸入的更新信息，所述更新信息用于對已顯示的接口文檔信息進行修改；

將所述更新信息發送至版本控制服務器（SVN），其中，版本控制服務器對接口文檔對應的程序進行更新。

7.一種接口文檔的生成裝置，其特征在于，包括：

讀取單元，用于從配置文件中讀取接口文檔信息,所述接口文檔信息用于描述接口程序；

生成單元，用于生成所述讀取單元讀取的接口文檔信息的顯示界面；

顯示單元，用于在所述生成單元生成的所述顯示界面中顯示所述讀取單元讀取的所述接口文檔信息。

8.根據權利要求7所述的裝置，其特征在于，所述讀取單元還用于，從配置文件中讀取接口信息、輸入參數信息、輸出參數信息、返回碼信息。

9.根據權利要求8所述的裝置，其特征在于，所述生成單元還用于：

生成接口文檔信息的表格形式顯示界面；

或者，生成接口文檔信息的文本框形式顯示界面；

或者，生成接口文檔信息的代碼形式顯示界面。

10.根據權利要求9所述的裝置，其特征在于，所述顯示單元還用于，在所述界面中以遞歸方式分別顯示所述輸入參數信息、輸出參數信息和返回碼信息。

11.根據權利要求10所述的裝置，其特征在于，

所述顯示單元還用于，顯示配置文件輸入界面；

所述裝置還包括：

接收單元，用于接收用戶通過所述顯示單元顯示的所述配置文件輸入界面輸入的接口文檔信息。

12.根據權利要求11所述的裝置，其特征在于，

所述接收單元還用于，接收用戶在所述顯示界面中輸入的更新信息，所述更新信息用于對已顯示的接口文檔信息進行修改；

所述裝置包括：

發送單元，用于將所述更新信息發送至版本控制服務器（SVN），其中，版本控制服務器對接口文檔對應的程序進行更新。