一種生成接口文檔的方法及裝置制造方法
【專利摘要】本發(fā)明公開了一種生成接口文檔的方法及裝置，屬于計算機【技術領域】。所述方法包括：獲取用戶待查看接口對應的代碼文件；在所述代碼文件中獲取接口注釋代碼，其中所述接口注釋代碼中保存有所述待查看接口的接口屬性信息以及該接口屬性信息對應的接口屬性參數(shù)；根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔。本發(fā)明通過在用戶查看接口時，獲取待查看接口對應的代碼文件，并從中獲取到接口屬性信息以及接口屬性信息對應的接口屬性參數(shù)。實現(xiàn)了對接口文檔的動態(tài)生成，提高了生成接口文檔的效率，并且提高了接口文檔中內(nèi)容的準確率。
【專利說明】一種生成接口文檔的方法及裝置
【技術領域】
[0001 ] 本發(fā)明涉及計算機【技術領域】，特別涉及一種生成接口文檔的方法及裝置。
【背景技術】
[0002]在應用開發(fā)的過程中，開發(fā)人員會根據(jù)測試或維護應用的需要，將開發(fā)應用時所使用的接口對應的各種屬性信息，以及屬性信息對應的屬性參數(shù)等內(nèi)容進行說明，并生成一份接口文檔以便后期進行使用。其中，接口是同一系統(tǒng)的不同功能層之間的通信規(guī)則。
[0003]現(xiàn)有技術中生成接口文檔的方式為:在應用的開發(fā)過程中，當編寫時涉及到新的接口時，則在接口文檔中以人工的方式寫入該接口的各種屬性、參數(shù)等接口說明；當某一個接口中所涉及的屬性信息以及屬性信息對應的屬性參數(shù)進行修改時，則在接口文檔中以人工的方式查找到該接口對應的接口說明，并進行對應的修改。
[0004]在實現(xiàn)本發(fā)明的過程中，發(fā)明人發(fā)現(xiàn)現(xiàn)有技術至少存在以下問題:
[0005]通過人工進行寫入或修改的接口文檔的方式，比較消耗時間，影響應用開發(fā)的進度；并且在接口更新或修改時，開發(fā)人員容易忽略對接口文檔中對應的接口說明的更新，因此會造成接口文檔中對接口的說明與代碼中接口的屬性信息以及屬性信息對應的屬性參數(shù)不符，而影響開發(fā)人員在應用開發(fā)后期的測試。

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

[0006]為了解決現(xiàn)有技術的問題，本發(fā)明實施例提供了一種生成接口文檔的方法及裝置。
[0007]一方面，本發(fā)明提供了一種生成接口文檔的方法，該方法包括:
[0008]獲取用戶待查看接口對應的代碼文件；
[0009]在所述代碼文件中獲取接口注釋代碼，其中所述接口注釋代碼中保存有所述待查看接口的接口屬性信息以及該接口屬性信息對應的接口屬性參數(shù)；
[0010]根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔。
[0011]優(yōu)選的，所述獲取用戶待查看接口對應的代碼文件，包括:
[0012]接收用戶在接口配置文件中選取的待查看接口的接口標識；
[0013]在預先存儲的接口標識與代碼文件的路徑信息的對應關系中，選取所述接口標識對應的代碼文件的路徑信息；
[0014]根據(jù)所述代碼文件的路徑信息，獲取所述待查看接口對應的代碼文件。
[0015]優(yōu)選的，所述在所述代碼文件中獲取預設的接口注釋代碼，包括:
[0016]在所述代碼文件的代碼頭中，查詢注釋代碼標簽；
[0017]將所述注釋代碼標簽中的代碼段確定為接口注釋代碼。
[0018]優(yōu)選的，所述根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔，包括:
[0019]在所述接口注釋代碼中，獲取預設的接口屬性信息對應的接口屬性參數(shù)；[0020]將所述預設的接口屬性信息對應的接口屬性參數(shù)，添加入預先存儲的接口文檔模版中包含的與所述預設的接口屬性信息相匹配的參數(shù)位置；
[0021 ] 將添加了接口屬性參數(shù)的接口文檔模版確定為所述待查看接口對應的接口文檔。
[0022]優(yōu)選的，所述根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔之后，所述方法還包括:
[0023]獲取所述待查看接口對應的測試用例代碼，并將所述測試用例代碼添加入所述待查看接口對應的接口文檔中，其中所述測試用例代碼用于根據(jù)對所述待查看接口進行測試使用。
[0024]另一方面，提供了一種生成接口文檔的裝置，所述裝置包括:
[0025]第一獲取模塊，用于獲取用戶待查看接口對應的代碼文件；
[0026]第二獲取模塊，用于在所述代碼文件中獲取接口注釋代碼，其中所述接口注釋代碼中保存有所述待查看接口的接口屬性信息以及該接口屬性信息對應的接口屬性參數(shù)；
[0027]生成模塊，用于根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔。
[0028]優(yōu)選的，所述第一獲取模塊，包括:
[0029]接收單元，用于接收用戶在接口配置文件中選取的待查看接口的接口標識；
[0030]選取單元，用于在預先存儲的接口標識與代碼文件的路徑信息的對應關系中，選取所述接口標識對應的代碼文件的路徑信息；
[0031]第一獲取單元，用于根據(jù)所述代碼文件的路徑信息，獲取所述待查看接口對應的代碼文件。
[0032]優(yōu)選的，所述第二獲取模塊，包括:
[0033]查詢單元，用于在所述代碼文件的代碼頭中，查詢注釋代碼標簽；
[0034]第一確定單元，用于將所述注釋代碼標簽中的代碼段確定為接口注釋代碼。
[0035]優(yōu)選的，所述生成模塊，包括:
[0036]第二獲取單元，用于在所述接口注釋代碼，獲取預設的接口屬性信息對應的接口屬性參數(shù)；
[0037]添加單元，用于將所述預設的接口屬性信息對應的接口屬性參數(shù)，添加入預先存儲的接口文檔模版中包含的與所述預設的接口屬性信息相匹配的參數(shù)位置；
[0038]第二確定單元，用于將添加了接口屬性參數(shù)的接口文檔模版確定為所述待查看接口對應的接口文檔。
[0039]優(yōu)選的，所述裝置包括:
[0040]添加模塊，用于獲取所述待查看接口對應的測試用例代碼，并將所述測試用例代碼添加入所述待查看接口對應的接口文檔中，其中所述測試用例代碼用于根據(jù)對所述待查看接口進行測試使用。
[0041]本發(fā)明實施例提供的技術方案帶來的有益效果是:
[0042]通過在用戶查看接口時，獲取待查看接口對應的代碼文件，并從中獲取到接口屬性信息以及接口屬性信息對應的接口屬性參數(shù)。實現(xiàn)了對接口文檔的動態(tài)生成，提高了生成接口文檔的效率，并且提高了接口文檔中內(nèi)容的準確率。
【專利附圖】

【附圖說明】[0043]為了更清楚地說明本發(fā)明實施例中的技術方案，下面將對實施例描述中所需要使用的附圖作簡單地介紹，顯而易見地，下面描述中的附圖僅僅是本發(fā)明的一些實施例，對于本領域普通技術人員來講，在不付出創(chuàng)造性勞動的前提下，還可以根據(jù)這些附圖獲得其他的附圖。
[0044]圖1是本發(fā)明實施例一提供的生成接口文檔的方法流程圖；
[0045]圖2是本發(fā)明實施例二提供的生成接口文檔的方法流程圖；
[0046]圖3是本發(fā)明實施例三提供的生成接口文檔的裝置結構示意圖。
【具體實施方式】
[0047]為使本發(fā)明的目的、技術方案和優(yōu)點更加清楚，下面將結合附圖對本發(fā)明實施方式作進一步地詳細描述。
[0048]實施例一
[0049]本發(fā)明實施例提供了一種生成接口文檔的方法，參見圖1，方法流程包括:
[0050]101:獲取用戶待查看接口對應的代碼文件；
[0051]102:在所述代碼文件中獲取接口注釋代碼，其中所述接口注釋代碼中保存有所述待查看接口的接口屬性信息以及該接口屬性信息對應的接口屬性參數(shù)；
[0052]103:根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔。
[0053]本發(fā)明實施例通過在用戶查看接口時，獲取待查看接口對應的代碼文件，并從中獲取到接口屬性信息以及接口屬性信息對應的接口屬性參數(shù)。實現(xiàn)了對接口文檔的動態(tài)生成，提高了生成接口文檔的效率，并且提高了接口文檔中內(nèi)容的準確率。
[0054]實施例二
[0055]本發(fā)明實施例提供了一種生成接口文檔的方法，參見圖2，方法流程包括:
[0056]201:獲取用戶待查看接口對應的代碼文件。
[0057]其中，預先將代碼中所涉及的接口保存在接口配置文件中，用戶可以通過在該配置文件中進行選取需要查看的接口，此時系統(tǒng)會得到接口對應的接口標識，并通過預先存儲的接口標識與代碼文件的路徑信息的對應關系，查詢到用戶選取的接口所在的代碼文件。
[0058]其中，接口可以為接口函數(shù)，還可以為HTTP (HTTP-Hypertext transferprotocol,超文本傳輸協(xié)議)接口。
[0059]因此步驟201可以具體為:
[0060]2011:接收用戶在接口配置文件中選取的待查看接口的接口標識。
[0061]其中，用戶先打開接口配置文件，在其中選取需要查看的接口，此時系統(tǒng)會獲取到用戶選取的待查看接口的接口標識。例如:以HTTP接口中用戶選擇face_detect人臉識別接口為例。用戶在接口配置文件中選取了該接口后，得到了該接口的接口標識:face_detect ο
[0062]2012:在預先存儲的接口標識與代碼文件的路徑信息的對應關系中，選取所述接口標識對應的代碼文件的路徑信息。
[0063]2013:根據(jù)所述代碼文件的路徑信息，獲取所述待查看接口對應的代碼文件。
[0064]從該路徑信息對應的路徑中，獲取保存待查看接口的代碼文件。[0065]202:在所述代碼文件中獲取接口注釋代碼，其中所述接口注釋代碼中保存有所述待查看接口的接口屬性信息以及所述接口屬性信息對應的接口屬性參數(shù)。
[0066]具體的，代碼文件中包含了接口以及該接口對應的接口注釋代碼，其中接口注釋代碼中保存了對該接口的接口說明，其中包含了接口的屬性信息以及屬性信息對應的屬性參數(shù)等內(nèi)容。[0067]因此，對于步驟202可以具體為:
[0068]2021:在所述代碼文件的代碼頭中，查詢注釋代碼標簽。
[0069]對于HTTP接口，一般將接口注釋代碼保存在代碼文件的代碼頭中。
[0070]例如:在PHP語言中，注釋代碼標簽為:“/*......*/”，在這對標簽中的內(nèi)容即為
注釋代碼。
[0071]2022:將所述注釋代碼標簽中的代碼段確定為接口注釋代碼。
[0072]其中對于接口注釋代碼，會根據(jù)不同的語言類型對應不同的注釋代碼標簽，通過該注釋代碼標簽，可以在代碼文件中查找到接口注釋代碼。其中，接口注釋代碼的格式在HTTP接口中可以為JSON格式。
[0073]203:根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔。
[0074]在接口注釋代碼中保存有接口屬性信息，以及接口屬性信息對應的接口屬性參數(shù)。
[0075]例如，在HTTP接口中，某接口的發(fā)送方式對應的接口屬性信息為“Method”，該接口屬性信息對應的接口屬性參數(shù)為“post”，接口的描述對應的接口屬性信息為“Description”,對應的接口屬性參數(shù)為“detect faces rect in image”對應在接口注釋代碼中的具體內(nèi)容為:
[0076]/*"Method":"post"
[0077]^Description^:〃detect faces rect in image^
[0078]*/
[0079]其中，接口屬性信息一般為預先設定好的內(nèi)容，其具體對應的接口屬性參數(shù)會不同，因此通過預設的接口屬性信息可以在接口注釋代碼中查詢到這個接口中該接口屬性信息對應的接口屬性參數(shù)。進一步的，在HTTP接口中，接口屬性信息還包括:輸入屬性信息“Input_Form_Data”,輸出屬性信息“0utput_JS0N”等接口屬性信息。
[0080]因此步驟203可以具體為:
[0081]2031:在所述接口注釋代碼中，獲取預設的接口屬性信息對應的接口屬性參數(shù)。
[0082]接口注釋代碼中預先保存有接口可能會涉及到的所有的接口屬性信息，通過在接口注釋代碼中進行比對，獲取到接口注釋代碼中存在的所有接口屬性信息，并根據(jù)這些存在的接口屬性信息獲取到對應的接口屬性參數(shù)。
[0083]2032:將所述預設的接口屬性信息對應的接口屬性參數(shù)，添加入預先存儲的接口文檔模版中包含的與所述預設的接口屬性信息相匹配的參數(shù)位置。
[0084]其中，預先存儲的接口文檔模版中包含根據(jù)接口注釋代碼中存在的接口屬性信息以及其對應的接口屬性參數(shù)適應性生成的表格。具體的表格的格式為:在表格的第一列中為接口屬性信息，第二列對應的位置為接口屬性信息對應的接口屬性參數(shù)，如表1所示:
[0085]
【權利要求】
1.一種生成接口文檔的方法，其特征在于，所述方法包括: 獲取用戶待查看接口對應的代碼文件； 在所述代碼文件中獲取接口注釋代碼，其中所述接口注釋代碼中保存有所述待查看接口的接口屬性信息以及該接口屬性信息對應的接口屬性參數(shù)； 根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔。
2.根據(jù)權利要求1所述的方法，其特征在于，所述獲取用戶待查看接口對應的代碼文件，包括: 接收用戶在接口配置文件中選取的待查看接口的接口標識； 在預先存儲的接口標識與代碼文件的路徑信息的對應關系中，選取所述接口標識對應的代碼文件的路徑信息； 根據(jù)所述代碼文件的路徑信息，獲取所述待查看接口對應的代碼文件。
3.根據(jù)權利要求1所述的方法，其特征在于，所述在所述代碼文件中獲取接口注釋代碼，包括: 在所述代碼文件的代碼頭中，查詢注釋代碼標簽； 將所述注釋代碼標簽中的代碼段確定為接口注釋代碼。
4.根據(jù)權利要求1所述的方法，其特征在于，所述根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔，.包括: 在所述接口注釋代碼中，獲取預設的接口屬性信息對應的接口屬性參數(shù)； 將所述預設的接口屬性信息對應的接口屬性參數(shù)，添加入預先存儲的接口文檔模版中包含的與所述預設的接口屬性信息相匹配的參數(shù)位置； 將添加了接口屬性參數(shù)的接口文檔模版確定為所述待查看接口對應的接口文檔。
5.根據(jù)權利要求1或4所述的方法，其特征在于，所述根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔之后，所述方法還包括: 獲取所述待查看接口對應的測試用例代碼，并將所述測試用例代碼添加入所述待查看接口對應的接口文檔中，其中所述測試用例代碼用于對所述待查看接口進行測試使用。
6.一種生成接口文檔的裝置，其特征在于，所述裝置包括: 第一獲取模塊，用于獲取用戶待查看接口對應的代碼文件； 第二獲取模塊，用于在所述代碼文件中獲取接口注釋代碼，其中所述接口注釋代碼中保存有所述待查看接口的接口屬性信息以及該接口屬性信息對應的接口屬性參數(shù)； 生成模塊，用于根據(jù)所述接口注釋代碼，生成所述待查看接口對應的接口文檔。
7.根據(jù)權利要求6所述的裝置，其特征在于，所述第一獲取模塊，包括: 接收單元，用于接收用戶在接口配置文件中選取的待查看接口的接口標識； 選取單元，用于在預先存儲的接口標識與代碼文件的路徑信息的對應關系中，選取所述接口標識對應的代碼文件的路徑信息； 第一獲取單元，用于根據(jù)所述代碼文件的路徑信息，獲取所述待查看接口對應的代碼文件。
8.根據(jù)權利要求6所述的裝置，其特征在于，所述第二獲取模塊，包括: 查詢單元，用于在所述代碼文件的代碼頭中，查詢注釋代碼標簽； 第一確定單元，用于將所述注釋代碼標簽中的代碼段確定為接口注釋代碼。
9.根據(jù)權利要求6所述的裝置，其特征在于，所述生成模塊，包括: 第二獲取單元，用于在所述接口注釋代碼，獲取預設的接口屬性信息對應的接口屬性參數(shù)； 添加單元，用于將所述預設的接口屬性信息對應的接口屬性參數(shù)，添加入預先存儲的接口文檔模版中包含的與所述預設的接口屬性信息相匹配的參數(shù)位置； 第二確定單元，用于將添加了接口屬性參數(shù)的接口文檔模版確定為所述待查看接口對應的接口文檔。
10.根據(jù)權利要求6或9所述的裝置，其特征在于，所述裝置還包括: 添加模塊，用于獲取所述待查看接口對應的測試用例代碼，并將所述測試用例代碼添加入所述待查看接口對 應的接口文檔中，其中所述測試用例代碼用于根據(jù)對所述待查看接口進行測試使用。
【文檔編號】G06F9/44GK103473045SQ201310379946
【公開日】2013年12月25日 申請日期:2013年8月27日 優(yōu)先權日:2013年8月27日
【發(fā)明者】李翀 申請人:廣州華多網(wǎng)絡科技有限公司