在laravel中使用apidoc的示例-创新互联
这篇文章将为大家详细讲解有关在laravel中使用apidoc的示例,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。
创新互联公司是一家集网站建设,绥棱企业网站建设,绥棱品牌网站建设,网站定制,绥棱网站建设报价,网络营销,网络优化,绥棱网站推广为一体的创新建站企业,帮助传统企业提升企业形象加强企业竞争力。可充分满足这一群体相比中小企业更为丰富、高端、多元的互联网需求。同时我们时刻保持专业、时尚、前沿,时刻以成就客户成长自我,坚持不断学习、思考、沉淀、净化自己,让我们为更多的企业打造出实用型网站。第一步:使用: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
如图:
目录结构如图:
关于“在laravel中使用apidoc的示例”这篇文章就分享到这里了,希望以上内容可以对大家有一定的帮助,使各位可以学到更多知识,如果觉得文章不错,请把它分享出去让更多的人看到。
网站名称:在laravel中使用apidoc的示例-创新互联
本文来源:http://pwwzsj.com/article/dcpdpd.html