apidoc 是一款api文檔生成工具，簡單易用隘截。apidoc會(huì)生成一個(gè)html，建議同時(shí)配置在服務(wù)器上汹胃，例如通過Nginx配置靜態(tài)資源婶芭，供多人協(xié)作瀏覽，配置好之后统台，每次修改了api雕擂，只需要一行命令即可完成文檔更新。
一贱勃、安裝
$npm install apidoc -g
二、配置（可選）
在項(xiàng)目目錄下添加 apidoc.json 文件
ex：{
"name": "example", //項(xiàng)目名稱
"version": "0.1.0",
"description": "apiDoc basic example",
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1" //一般為域名
}
三谤逼、基本格式
在相關(guān)文件內(nèi)加入注釋贵扰，ex：
/**
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*@apiPermission Web
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname? Lastname of the User.
* @apiSuccessExample Success-Response:
*? ? HTTP/1.1 200 OK
*? ? {
*? ? ? "firstname": "John",
*? ? ? "lastname": "Doe"
*? ? }
*/
三、基本命令
ex:
$ apidoc -i controller -o doc
controller:輸入目錄流部，添加了上面的api注釋的目錄
-o :文檔輸出目錄
四戚绕、使用
打開doc目錄下的index.html文件，即可看到剛剛生成的api文檔枝冀。
如果配置到服務(wù)器上舞丛，使用方法同理。
