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 }}
如图:
第三步:使用apidoc -i myapp/ -o apidoc/ -t mytemplate/
其中: -i 表示输入,后面是文件夹路径-o 表示输出,后面是文件夹路径默认会带上-c,在当前路径下寻找配置文件(apidoc.json),如果找不到则会在package.json中寻找 apidoc: { } myapp/ 表示要生成api的源文档所在目录位置 mytemplete/ 表示要生成api到的目录位置
如:我要将app/Http/Controllers/Api/
目录下的文档生成api文件到public/api
的命令如下:
apidoc -i app/Http/Controllers/Api/ -o public/api
如图:
目录结构如图:
原文地址:https://www.jb51.cc/laravel/1199387.html
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。