直接生成文檔的神器 apidoc
1 win+R 輸入 cmd 回車 然后進入 nodejs 項目目錄
例如 D:\NodeTest\newApp1
2 用npm安裝 apidoc
直接輸入 npm install apidoc -g 按回車
3 打開項目的 package.json文件
加入 "apidoc": { "title": "apiDoc在瀏覽器中的標題", "url" : "https://api.github.com/v1" }
4 給接口添加注釋
例如
/**
* @api {post} /api/User/register 用戶注冊
* @apiDescription 用戶注冊
* @apiName Register
* @apiGroup User
* @apiParam {string} name 用戶名
* @apiParam {string} password 密碼
* @apiVersion 1.0.0
*/
5 生成 apidoc
輸入 apidoc -i api/ -o apidoc/
如果 提示 error: Can not read: package.json, please check the format (e.g. missing comma).
說明package.json文件格式不正確，或者編碼不對，需要改為utf8 無簽名 即可
如果提示 info: Done. 說明生成成功，
打開項目文件夾 會發現生成新目錄apidoc，雙擊打開里面的index.html 即可。
官方地址 http://apidocjs.com/
參考 http://blog.csdn.net/soslinken/article/details/50468896