本篇文章给大家介绍了关于apidoc的使用 ，有感兴趣的朋友可以看一看
说明apidoc creates a documentation from api annotations in your source code
apidoc是一个接口文档，它的创建方式是基于你的源代码的接口备注。我们只需要给接口写好相应的文档，然后使用apidoc生成接口文档工具生成文档，便于管理和查看。
配置方式
1.安装apidoc（npm是啥？？？自己问前端同学吧。。）
npm install apidoc -g
安装http-server
npm install http-server -g
2.给接口添加文档（官方示例），添加在controller入口方法前面。
/**  * @api {get} /user/:id request user information  * @apiname getuser  * @apigroup user  *  * @apiparam {number} id users unique id.  *  * @apisuccess {string} firstname firstname of the user.  * @apisuccess {string} lastname  lastname of the user.  */
3.创建apidoc.json(官方示例)
{   name: example,   version: 0.1.0,   description: apidoc basic example,   apidoc: {     title: custom apidoc browser title,     url : https://api.github.com/v1   } }
4.生成apidoc
apidoc -i app/http/controllers -o apidoc/
5.运行
http-server api/doc
补充备注
参考http://apidocjs.com/
以上就是apidoc的使用 的详细内容。