api 生成接口文档示例：

1. { 
2.  
3.   "name": "9月份赠险领取分享活动微信接口", 
4.  
5.   "version": "1.0.0", 
6.  
7.   "description": "9月份赠险领取分享活动微信接口文档 (t=1) ", 
8.  
9.   "sampleUrl" : "http://www.phpfensi.com/" 
10.  
11. } 

另存文件名为：apidoc.json

apidoc -i 要生成文档的项目目录 -o 接口文件的生成目录

接口代码文件代码如下：

1. /** 
2.  * @api {post} /news/lists 新闻信息列表 
3.  * @apiVersion 1.0.0 
4.  * @apiName lists 
5.  * @apiGroup User 
6.  * @apiPermission 登录用户 
7.  * 
8.  * @apiDescription 用户登录后进入该页面，将显示新闻信息列表 
9.  * 
10.  * @apiSampleRequest /v1/news/lists 
11.  * 
12.  * @apiSuccess (返回值) {string} id 主键ID 
13.  * @apiSuccess (返回值) {string} name 客户姓名 
14.  * @apiSuccess (返回值) {string} user_head_img 客户头像 
15.  * @apiSuccess (返回值) {integer} sex 性别:0-未设置,1-男,2-女 
16.  * @apiSuccess (返回值) {string} demand 客户需求 
17.  * 
18.  * @apiSuccessExample {json} 成功示例: 
19.  * {"code": 1,"msg": "","data": {"id": "57b3cdb46b787","name": "余浩苗","user_head_img": "userHead/2016-08-18/1034587522576.jpg","sex": "1","demand": "本人想买保险，请速联系！"}} 
20.  * 
21.  * @apiErrorExample (json) 错误示例: 
22.  *     {"code":-1,"msg":"密码错误","data":{}} 
23.  */ 
24.  
25. /////////////////////////////////////// 
26.  
27. /** 
28.  * @api {post} /news/rob 抢客户 
29.  * @apiVersion 1.0.0 
30.  * @apiName rob 
31.  * @apiGroup User 
32.  * @apiPermission 登录用户 
33.  * 
34.  * @apiDescription 抢客户 
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) 错误示例: 
44.  *     {"code":-1,"msg":"错误信息","data":{}} 
45.  */ 

更多关于apidoc的用法请参考：http://apidocjs.com/

Tags: 示例 接口 文档

分享到：