[發明專利]基于Javadoc的自動生成后端接口文檔的方法及裝置

在審

• 申請號: 201710601429.X
• 申請日: 2017-07-21
• 公開（公告）號: CN107463376A
• 公開（公告）日: 2017-12-12
• 發明（設計）人: 譚海潮
• 申請（專利權）人: 珠海牛角科技有限公司
• 主分類號: G06F9/44
• 分類號: G06F9/44
• 代理公司: 北京酷愛智慧知識產權代理有限公司11514
• 代理人: 安娜

1.一種基于Javadoc的自動生成后端接口文檔的方法，其特征在于：具體包括以下步驟，在接口文件中定義接口信息；采用Javadoc對接口信息進行描述，描述代碼的注釋和接口；采用AST解析代碼自動識別，識別出接口的輸入參數、返回值類型、URL和異常數據；根據接口的定義和標準的Javadoc來全自動化生成接口文檔。

2.如權利要求1所述的基于Javadoc的自動生成后端接口文檔的方法，其特征在于：所述采用Javadoc對接口信息進行描述，描述代碼的注釋和接口具體包括以下步驟：約定Javadoc中的第一行為注釋名稱，描述接口的名稱；約定Javadoc中的大于等于第二行為接口信息描述；約定在POJO類的Javadoc前加上@mutable標記，表明當前的POJO是一個多態的POJO，所述多態的POJO有多個子類。

3.如權利要求2所述的基于Javadoc的自動生成后端接口文檔的方法，其特征在于：所述識別出輸入參數的方法具體包括以下步驟：約定接口的參數中含有登錄用戶參數，根據登錄用戶參數判斷是否需要進行登錄驗證；約定分頁參數；對接口的輸入參數解析，自動解析參數名稱、參數類型和注釋名稱生成接口文檔中的輸入參數說明。

4.如權利要求3所述的基于Javadoc的自動生成后端接口文檔的方法，其特征在于：所述識別接口的URL的方法包括識別出Controller類的RequestMapping中的值作為URL中的目錄，用Controller類函數的RequestMapping的值作為文件名；如果RequestMapping沒有值，自動使用Controller類函數名稱作為文件名。

5.如權利要求4所述的基于Javadoc的自動生成后端接口文檔的方法，其特征在于：所述識別出異常數據的方法采用根據接口的異常定義自動解析異常的類名為接口的錯誤碼，并將異常的message或異常的注釋名稱作為錯誤消息。

6.如權利要求2所述的基于Javadoc的自動生成后端接口文檔的方法，其特征在于：所述多態的POJO包含一個類別屬性，每個子類的類別屬性值不同，屬性值解析后輸出到接口文檔，子類的注釋名稱為子類的中文描述。

7.一種基于Javadoc的自動生成后端接口文檔的裝置，其特征在于：包括接口定義模塊，用于在接口文件中定義接口信息；描述模塊，采用Javadoc對接口信息進行描述，描述代碼的注釋和接口；AST解析代碼自動識別模塊，采用AST解析代碼自動識別，識別出接口的輸入參數、返回值類型、URL和異常數據；接口文檔生成模塊，根據接口定義和標準的Javadoc來全自動化生成接口文檔。

8.如權利要求7所述的基于Javadoc的自動生成后端接口文檔的裝置，其特征在于：所述接口定義模塊的具體工作方法為：約定Javadoc中的第一行為注釋名稱，描述類的名稱；約定Javadoc中的大于等于第二行為接口信息描述；約定在POJO類的Javadoc前加上@mutable標記，表明當前的POJO是一個多態的POJO，所述多態的POJO有多個子類。

9.如權利要求7所述的基于Javadoc的自動生成后端接口文檔的裝置，其特征在于：所述AST解析代碼自動識別模塊包括輸入參數識別模塊、輸出參數識別模塊、URL識別模塊和異常識別模塊，所述輸入參數識別模塊用于約定接口的參數中含有登錄用戶參數，根據登錄用戶參數判斷是否需要進行登錄驗證；約定分頁參數；對接口的輸入參數解析，自動解析參數名稱、參數類型和注釋名稱生成接口文檔中的輸入參數說明；所述輸出參數識別模塊用于根據接口的輸出的返回值類型識別出接口文檔的返回值；所述URL識別模塊識別出Controller類的RequestMapping中的值作為URL中的目錄，用Controller類函數的RequestMapping的值作為文件名；如果RequestMapping沒有值，自動使用Controller類函數名稱作為文件名；所述異常識別模塊根據接口的異常定義自動解析異常類名為接口的錯誤碼，并將異常的message或異常的注釋名稱作為錯誤消息。

10.如權利要求7所述的基于Javadoc的自動生成后端接口文檔的裝置，其特征在于：所述多態的POJO包含一個類別屬性，每個子類的類別屬性值不同，屬性值解析后輸出到接口文檔，子類的注釋名稱為子類的中文描述。