安装步骤
apidoc官方文档:http://apidocjs.com/#params
运行命令:npm install apidoc -g
一、配置项目
在项目根目录下新建apidoc.json文件 内容如下:
{
"name": "laravel_demo接口文档",
"version": "0.23.0",
"description": "接口文档",
"apidoc": {
"title": "接口文档",
"url" : "http://apidemo.youkac.com/apidoc/"
}
}
version 可以根据命令:apidoc -v 查看填写 填写不正确文档打开时会出现一直加载中的状态
二、生成文档
apidoc -i app/Http/Controllers/ -o public/apidoc
- -i 表示要生成的控制器路径
- -o 表示生成的文件存储位置