api 生成接口文檔示例：

1. { 
2.  
3.   "name": "9月份贈(zèng)險(xiǎn)領(lǐng)取分享活動(dòng)微信接口", 
4.  
5.   "version": "1.0.0", 
6.  
7.   "description": "9月份贈(zèng)險(xiǎn)領(lǐng)取分享活動(dòng)微信接口文檔 (t=1) ", 
8.  
9.   "sampleUrl" : "http://m.survivalescaperooms.com/" 
10.  
11. } 

另存文件名為：apidoc.json

apidoc -i 要生成文檔的項(xiàng)目目錄 -o 接口文件的生成目錄

接口代碼文件代碼如下：

1. /** 
2.  * @api {post} /news/lists 新聞信息列表 
3.  * @apiVersion 1.0.0 
4.  * @apiName lists 
5.  * @apiGroup User 
6.  * @apiPermission 登錄用戶(hù) 
7.  * 
8.  * @apiDescription 用戶(hù)登錄后進(jìn)入該頁(yè)面，將顯示新聞信息列表 
9.  * 
10.  * @apiSampleRequest /v1/news/lists 
11.  * 
12.  * @apiSuccess (返回值) {string} id 主鍵ID 
13.  * @apiSuccess (返回值) {string} name 客戶(hù)姓名 
14.  * @apiSuccess (返回值) {string} user_head_img 客戶(hù)頭像 
15.  * @apiSuccess (返回值) {integer} sex 性別:0-未設(shè)置,1-男,2-女 
16.  * @apiSuccess (返回值) {string} demand 客戶(hù)需求 
17.  * 
18.  * @apiSuccessExample {json} 成功示例: 
19.  * {"code": 1,"msg": "","data": {"id": "57b3cdb46b787","name": "余浩苗","user_head_img": "userHead/2016-08-18/1034587522576.jpg","sex": "1","demand": "本人想買(mǎi)保險(xiǎn)，請(qǐng)速聯(lián)系！"}} 
20.  * 
21.  * @apiErrorExample (json) 錯(cuò)誤示例: 
22.  *     {"code":-1,"msg":"密碼錯(cuò)誤","data":{}} 
23.  */ 
24.  
25. /////////////////////////////////////// 
26.  
27. /** 
28.  * @api {post} /news/rob 搶客戶(hù) 
29.  * @apiVersion 1.0.0 
30.  * @apiName rob 
31.  * @apiGroup User 
32.  * @apiPermission 登錄用戶(hù) 
33.  * 
34.  * @apiDescription 搶客戶(hù) 
35.  * 
36.  * @apiParam {string} id 主鍵ID 
37.  * 
38.  * @apiSampleRequest /v1/news/rob 
39.  * 
40.  * @apiSuccessExample {json} 成功示例: 
41.  * {"code":1,"msg":"","data":{}} 
42.  * 
43.  * @apiErrorExample (json) 錯(cuò)誤示例: 
44.  *     {"code":-1,"msg":"錯(cuò)誤信息","data":{}} 
45.  */ 

更多關(guān)于apidoc的用法請(qǐng)參考：http://apidocjs.com/