apidoc介紹：

apidoc可以根據代碼注釋生成web api文檔，支持大部分主流語言java javascript php coffeescript erlang perl python ruby go...，相對而言，web接口的注釋維護起來更加方便，不需要額外再維護一份文檔。apidoc從注釋生成靜態html網頁文檔，不僅支持項目版本號，還支持api版本號。

本例基于nutz開源框架構建,寫的文檔，可以借鑒

如上邊的修改密碼的樣子生成模板：

package cn.lvche.doc; 
/**
 * @author William 2017年12月12日14:57:49 
 *
 */
public class UserInfoModifyApiDoc { 
}
/**
 * @api {post} localhost:8011/user/modifyInfo/do____『2017年12月12日14:57:56』      W-用戶信息修改
 * @apiGroup user
 * @apiVersion 1.0.0
 * @apiPermission anyOne  
 * @apiParam {String}	userAccount 			賬號
 * @apiParam {String}	nickName 				昵稱
 * @apiParam {String}	email 				              郵箱
 *
 * @apiSuccess {string} returnCode 			              返回碼
 * @apiSuccess {string} code 			                            返回碼
 * @apiSuccess {string} msg 			                            提示語
 * @apiSuccess {[Object]} data 			      	數據對象		    	
 * @apiSuccess {String} data.fduserid			用戶id
 * @apiSuccess {String} data.fduseracc			用戶賬號
 * @apiSuccess {String} data.fdusercreateat		用戶創建時間
 * @apiSuccess {String} data.fdusername			用戶名
 * @apiSuccess {String} data.fduseremail		用戶郵箱
 * @apiSuccess {String} data.fduserqq			用戶qq
 * @apiSuccess {String} data.fdusermsn 			用戶msn
 * @apiSuccess {String} data.fdusersort			用戶排序
 * @apiSuccess {String} data.fduserstatus		登錄狀態
 * @apiSuccess {String} data.fduserloginip		登錄ip
 * @apiSuccess {String} data.fduserloginat		用戶登錄時間
 * @apiSuccess {String} data.fduserkey			用戶key
 * @apiSuccess {String} data.fduserdepartment	用戶部門
 * @apiSuccess {String} data.fdusergrade		用戶等級
 * @apiSuccess {String} data.fduserphone		用戶手機號
 * @apiSuccess {String} data.userAvatar			用戶頭像
 * @apiSuccess {String} data.sessionKey			sessionKey
 * @apiSuccess {String} data.companyNum			企業號
 * @apiSuccess {String} data.companyInfo		 企業信息		
 * @apiSuccess {String} data.ip					企業ip
 * @apiSuccess {String} data.port				企業端口號  
 * @apiSuccessExample {json} 示例
 * 參數例子:
 * =====================================================
 * userAccount:william
 * nickName:管***
 * email:****@jo****.com
 * =====================================================
 * HTTP/1.1 200 OK
 *
{
    "returnCode": "SUCCESS",
    "code": "0",
    "msg": "登錄成功！",
    "data": {
        "fduserid": "1",
        "fduseracc": "ad***",
        "fdusercreateat": "2008-11-14",
        "fdusername": "***",
        "fduseremail": "***@***len.com",
        "fduserqq": "123456789",
        "fdusermsn": "wHy@****eage.com",
        "fdusersort": "1",
        "fduserstatus": "1",
        "fduserloginip": "192.168.1.134",
        "fduserloginat": "2017-12-07",
        "fduserkey": "636396144571760904",
        "fduserdepartment": "技術部",
        "fdusergrade": "1",
        "fduserphone": "",
        "userAvatar": "http://www.qqzhi.com/uploadpic/2015-02-02/211841154.jpg",
        "sessionKey": "123456789123456789dddddd",
        "companyNum": "123456",
        "companyInfo": "潮流前線",
        "ip": "127.0.0.1",
        "port": "8080"
    }
}
 * @apiError (失敗) {string} code 不等于0
 * @apiError (失敗) {string} msg 錯誤文字描述
 * @apiErrorExample {json} 示例
 * 參數例子:
 * =====================================================
 * userAccount:
 * nickName:管***
 * email:****@jo****.com
 * =====================================================
 * HTTP/1.1 200 OK
 * 
{
    "returnCode": "ERROR",
    "code": "-1",
    "msg": "賬號不能為空，請核對后再試！",
    "data": {}
}
 */

api操作更新，進入到smartC.cms根目錄，dos命令窗口下執行下邊語句

apidoc -i src/main/java apidoc_out

如果沒有apidoc情況下，先用nodejs安裝npm apidoc插件

npm install apidoc -g

附贈工作空間結構圖：

以上就是關于“API開發接口文檔開發利器：apidoc”的介紹，如果您想了解更多相關知識，不妨來關注一下動力節點的Java在線學習，里面的內容從入門到精通，通俗易懂，適合初學者，希望對大家能夠有所幫。