教你在laravel中使用apidoc!

发布时间 - 2020-07-21 00:00:00    点击率:

下面由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  # 文档  # 如图  # 如有  # 找不到  # 给大家  # 收货  # 要将  # 第二步  # 则会  # 开发人员 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: edge浏览器无法安装扩展 edge浏览器插件安装失败【解决方法】  Python3.6正式版新特性预览  Android中AutoCompleteTextView自动提示  Laravel Livewire是什么_使用Laravel Livewire构建动态前端界面  HTML5空格和nbsp有啥关系_nbsp的作用及使用场景【说明】  手机怎么制作网站教程步骤,手机怎么做自己的网页链接?  Thinkphp 中 distinct 的用法解析  如何用VPS主机快速搭建个人网站?  Win11搜索栏无法输入_解决Win11开始菜单搜索没反应问题【技巧】  jQuery中的100个技巧汇总  zabbix利用python脚本发送报警邮件的方法  利用 Google AI 进行 YouTube 视频 SEO 描述优化  JS弹性运动实现方法分析  Laravel如何配置.env文件管理环境变量_Laravel环境变量使用与安全管理  如何快速生成橙子建站落地页链接?  网站建设要注意的标准 促进网站用户好感度!  Bootstrap CSS布局之列表  如何在企业微信快速生成手机电脑官网?  Android自定义控件实现温度旋转按钮效果  大连企业网站制作公司,大连2025企业社保缴费网上缴费流程?  大同网页,大同瑞慈医院官网?  java获取注册ip实例  Laravel如何将应用部署到生产服务器_Laravel生产环境部署流程  Laravel怎么配置自定义表前缀_Laravel数据库迁移与Eloquent表名映射【步骤】  如何用AI帮你把自己的生活经历写成一个有趣的故事?  Google浏览器为什么这么卡 Google浏览器提速优化设置步骤【方法】  Angular 表单中正确绑定输入值以确保提交与验证正常工作  购物网站制作费用多少,开办网上购物网站,需要办理哪些手续?  高端建站三要素:定制模板、企业官网与响应式设计优化  微信公众帐号开发教程之图文消息全攻略  C#如何调用原生C++ COM对象详解  HTML透明颜色代码怎么让图片透明_给img元素加透明色的技巧【方法】  详解免费开源的DotNet二维码操作组件ThoughtWorks.QRCode(.NET组件介绍之四)  如何在景安云服务器上绑定域名并配置虚拟主机?  Laravel如何使用Seeder填充数据_Laravel模型工厂Factory批量生成测试数据【方法】  WordPress 子目录安装中正确处理脚本路径的完整指南  Laravel与Inertia.js怎么结合_使用Laravel和Inertia构建现代单页应用  为什么php本地部署后css不生效_静态资源加载失败修复技巧【技巧】  装修招标网站设计制作流程,装修招标流程?  详解Huffman编码算法之Java实现  网站建设保证美观性,需要考虑的几点问题!  教你用AI润色文章,让你的文字表达更专业  Java Adapter 适配器模式(类适配器,对象适配器)优缺点对比  如何在阿里云虚拟机上搭建网站?步骤解析与避坑指南  Laravel如何实现密码重置功能_Laravel密码找回与重置流程  网站制作怎么样才能赚钱,用自己的电脑做服务器架设网站有什么利弊,能赚钱吗?  如何用已有域名快速搭建网站?  如何在阿里云服务器自主搭建网站?  如何打造高效商业网站?建站目的决定转化率  做企业网站制作流程,企业网站制作基本流程有哪些?