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

如图:laravel中使用apidoc

第三步:使用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

目录结构如图:laravel中使用apidoc

创新互联www.cdcxhl.cn,专业提供香港、美国云服务器,动态BGP最优骨干路由自动选择,持续稳定高效的网络助力业务部署。公司持有工信部办法的idc、isp许可证, 机房独有T级流量清洗系统配攻击溯源,准确进行流量调度,确保服务器高可用性。佳节活动现已开启,新人活动云服务器买多久送多久。


名称栏目:laravel中使用apidoc-创新互联
URL标题:http://bzwzjz.com/article/eegoj.html

其他资讯

Copyright © 2007-2020 广东宝晨空调科技有限公司 All Rights Reserved 粤ICP备2022107769号
友情链接: 四川成都网站设计 成都网站建设 营销网站建设 手机网站制作 成都网站设计制作公司 成都响应式网站建设 企业网站建设 企业网站建设公司 重庆网站建设 成都网站建设公司 成都网站制作 营销网站建设 成都网站设计 外贸网站设计方案 高端品牌网站建设 成都网站制作 教育网站设计方案 手机网站制作 品牌网站建设 成都网站设计 企业网站设计 成都网站设计