教你在laravel中使用apidoc!

下面由Laravel教程栏目给大家介绍在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"
  }}

如图:

第三步:使用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!
URL标题:https://www.cdcxhl.com/article12/cjihgc.html

成都网站建设公司_创新互联,为您提供外贸网站建设网站改版Google关键词优化营销型网站建设网站设计公司

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联

成都网站建设公司