首页 > 代码库 > laravel中使用apidoc
laravel中使用apidoc
apidoc官方文档：http://apidocjs.com/#params
第一步：使用：npm install apidoc -g
命令安装apidoc。
第二步：在项目根目录下新建apidoc.json文件，文件内容格式参考如下：
{
"name": "laravel5 API文档",
"version": "v1.0",
"description": "本文档提供laravel5 商品，订单，收货地址，等API文档供嗨聊服务端开发人员作为参考，文档使用RESTfull风格，如有疑问请联系开发者",
"apidoc": {
"title": "laravel5 API文档",
"url" : "http://http://www.learnlaravel5.com//api"
}}123456789123456789如图：
第三步：使用apidoc -i myapp/ -o apidoc/ -t mytemplate/"
其中：
-i 表示输入，后面是文件夹路径-o 表示输出，后面是文件夹路径默认会带上-c，在当前路径下寻找配置文件(apidoc.json)，如果找不到则会在package.json中寻找 "apidoc": { }
myapp/ 表示要生成api的源文档所在目录位置
mytemplete/ 表示要生成api到的目录位置12345671234567如：我要将app/Http/Controllers/Api/目录下的文档生成api文件到public/api的命令如下：
apidoc -i app/Http/Controllers/Api/ -o public/api11
如图：
目录结构如图：
laravel中使用apidoc
声明：以上内容来自用户投稿及互联网公开渠道收集整理发布，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任，若内容有误或涉及侵权可进行投诉： 投诉/举报 工作人员会在5个工作日内联系你，一经查实，本站将立刻删除涉嫌侵权内容。