ApiDoc工具使用简介

ApiDoc工具使用简介

apiDoc是一个接口文档，它的创建方式是基于你的源代码的接口备注。我们只需要给接口写好相应的文档，然后使用apiDoc生成接口文档工具生成文档，便于管理和查看

安装配置

---

1.安装apidoc

npm install apidoc -g

npm简单介绍（前端同学应该都知道）
安装node.js node官网下载
查看是否安装成功
node -v
npm -v

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 public/apidoc/

#将app/Http/Controllers目录下的控制器生成api文档添加到public/apidoc目录中

就这样就可以打开你项目中生成的对应的apidoc目录，就会现在对应文档

参考

apidoc官网