apidoc生成接口文档示例
api 生成接口文档示例：
{
"name": "9月份赠险领取分享活动微信接口",
"version": "1.0.0",
"description": "9月份赠险领取分享活动微信接口文档 (t=1) ",
"sampleUrl" : "http://www.phpernote.com/"
}
另存文件名为：apidoc.json
apidoc -i 要生成文档的项目目录 -o 接口文件的生成目录
接口代码文件代码如下：
<?php
/**
* @api {post} /news/lists 新闻信息列表
* @apiVersion 1.0.0
* @apiName lists
* @apiGroup User
* @apiPermission 登录用户
*
* @apiDescription 用户登录后进入该页面，将显示新闻信息列表
*
* @apiSampleRequest /v1/news/lists
*
* @apiSuccess (返回值) {string} id 主键ID
* @apiSuccess (返回值) {string} name 客户姓名
* @apiSuccess (返回值) {string} user_head_img 客户头像
* @apiSuccess (返回值) {integer} sex 性别:0-未设置,1-男,2-女
* @apiSuccess (返回值) {string} demand 客户需求
*
* @apiSuccessExample {json} 成功示例:
* {"code": 1,"msg": "","data": {"id": "57b3cdb46b787","name": "曹操","user_head_img": "userHead/2016-08-18/1034587522576.jpg","sex": "1","demand": "本人想买保险，请速联系！"}}
*
* @apiErrorExample (json) 错误示例:
* {"code":-1,"msg":"密码错误","data":{}}
*/
///////////////////////////////////////
/**
* @api {post} /news/rob 抢客户
* @apiVersion 1.0.0
* @apiName rob
* @apiGroup User
* @apiPermission 登录用户
*
* @apiDescription 抢客户
*
* @apiParam {string} id 主键ID
*
* @apiSampleRequest /v1/news/rob
*
* @apiSuccessExample {json} 成功示例:
* {"code":1,"msg":"","data":{}}
*
* @apiErrorExample (json) 错误示例:
* {"code":-1,"msg":"错误信息","data":{}}
*/
///////////////////////////////////////
更多关于apidoc的用法请参考：http://apidocjs.com/
转载请注明出处：php程序员的笔记
最后修改时间：2016年09月27日 11时41分 文章来源：-わ千与千寻
下一篇：php调试打印方法
热门文章