一、apidoc簡介
apidoc是一款可以有源代碼中的注釋直接自動生成api接口文檔的工具，它幾乎支持目前主流的所有風格的注釋。這里只以node為例。
二、環境安裝及配置
- 安裝node
- 全局安裝 apidoc，運行如下命令
npm install apidoc -g
- 在你的項目根目錄下新建apidoc.json文件，這個文件主要包含一些項目的描述信息，比如標題、簡短的描述、版本等，你也可以加入一些可選的配置項，比如頁眉、頁腳、模板等。 apidoc.json
{
"name": "example",
"version": "0.1.0",
"description": "apiDoc basic example",
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1"
}
如果你的項目中使用了package.json文件(例如:node.js工程)，那么你可以將apidoc.json文件中的所有配置信息放到package.json文件中的apidoc參數中：
{
"name": "example",
"version": "0.1.0",
"description": "apiDoc basic example",
"apidoc": {
"title": "Custom apiDoc browser title",
"url" : "https://api.github.com/v1"
}
}
Linux 安裝 apidoc 請參考：http://www.itinfor.cn/archives/1727
三、使用樣例
在項目根目錄（含有apidoc.json的目錄）中新建 src 文件，里面放 apidoc.js 的文件，apidoc.js 內容如下：
/**
*
* @apiDefine RkNotFoundException
*
* @apiError RkNotFoundException 找不到相關數據
*
* @apiErrorExample Error-Response:
* HTTP/1.1 404 Not Found
* {
* "error": {
* "code": 404,
* "msg": "",
* "path" ""
* }
* }
*
*/
運行如下命令，生成apidoc文檔。命令如下：
apidoc -i src/ -o output/
-
src/是輸入文件夾，即有注釋的地方，output/是api文檔輸出的地方。文件名根據項目來修改，這里只做demo。
運行成功后，會自動生成 output文件夾，里面包含接口文檔。
命令運行成功
demo文件目錄
四、apidoc注釋參數
項目暫時沒有寫api文檔的需求，所以詳細的參數介紹后續更新。。。參考
