Laravel apiDoc配置

最新推荐文章于 2022-11-15 17:08:09 发布
最新推荐文章于 2022-11-15 17:08:09 发布
阅读量377 收藏
点赞数
分类专栏： laravel
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_58357323/article/details/117699450
版权

Laravel 安装apiDoc 组件

//根目录下composer安装apidoc
composer require mpociot/laravel-apidoc-generator

//复制配置文件到config/目录中
php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config

apidoc配置文件在config/apidoc.php

默认生成api接口文档type类型是static ，是生成的html文件，laravel类型生成的是laravel的blade模板

//生成apidoc文件
php artisan api:generate

执行过程中可能会中断，但是不会给提示，这点比较坑，（因为apidoc是扫描的routes/目录下的路由文件），把执行到的最后一条的下一条注释掉，或者调试下，再次执行php artisan api:generate就可以了，

static类型执行完会在，public/docs下生成html文件，
目录下会生成connection.json文件，可以导入到postman中·，会自动api接口目录，url名称自动配置好，非常方便

官方网址：https://beyondco.de/docs/laravel-apidoc-generator/getting-started/installation

m0_58357323
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
laravel-apidoc-generator：Laravel API文档生成器
02-03
Laravel API文档生成器 从现有的Laravel / Lumen / 路线自动生成API文档。 php artisan apidoc:generate 安装 需要PHP 7.2和Laravel / Lumen 5.7或更高版本。 如果您的应用程序不满足这些要求，则可以签出3.x分支以获取较旧的版本。 composer require --dev mpociot/laravel-apidoc-generator Laravel 通过运行以下命令发布配置文件： php artisan vendor:publish --provider= " Mpociot\ApiDoc\ApiDo
laravel 中使用apidoc
三千
07-31 613
apidoc官方文档：http://apidocjs.com/#params 第一步： 使用：npm install apidoc -g 命令全局安装apidoc 第二步：在项目根目录下新建apidoc。json文件，文件内容合适参考如下： { "name":"laravel5API文档", "version":"1.0.0", "description":...
laravel中使用apidoc
leedaning的专栏
04-05 8550
apidoc官方文档：http://apidocjs.com/#params第一步：使用：npm install apidoc -g 命令安装apidoc。 第二步：在项目根目录下新建apidoc.json文件，文件内容格式参考如下：{ "name": "laravel5 API文档", "version": "v1.0", "description": "本文档提供laravel5
laravel-apidoc-generator, Laravel API文档生成器.zip
10-10
laravel-apidoc-generator, Laravel API文档生成器 Laravel API文档生成器自动从现有的Laravel 路由生成你的API文档。 让我们看一下示例文档。php artisan api:gen --routePrefix="settings/api/*"
API文档 、apiDoc、 部分使用、指南、安装、配置
【CSDN】
12-14 604
本文主要参考 npm install apidoc -g 配置 在你的项目根目录下新建apidoc.json文件，该文件描述了项目对外提供接口的概要信息如名称、版本、描述、文档打开时浏览器显示标题和接口缺省访问地址。apidoc.json { "name": "ServiceEbikeAPIs", "version": "3.1.0", "description": "车辆服务接口文档", "title": "ServiceEbikeAPIs", "url" :..
Laravel开发-laravel-apidoc
08-27
Laravel开发-laravel-apidoc 生成所有路由的邮差集合
Laravel开发-apidoc
08-28
Laravel开发-apidoc 生成API文档并使用Swagger来使用它
Laravel开发-laravel-apidoc-generator
08-27
Laravel开发-laravel-apidoc-generator 从Laravel应用程序生成漂亮的API文档
laravel 使用apidoc
weixin_43311817的博客
04-01 278
文章目录安装步骤apidoc官方文档：http://apidocjs.com/#params一、配置项目二、生成文档 安装步骤 apidoc官方文档：http://apidocjs.com/#params 运行命令：npm install apidoc -g 一、配置项目 在项目根目录下新建apidoc.json文件 内容如下： { "name": "laravel_demo接口文档", "version": "0.23.0", "description": "接口文档", "apid
安装配置apidoc
bcqd1211的博客
01-21 973
1：首先需要安装node.js 网址： https://nodejs.org/en/#download 2：输入命令进行安装 npm install apidoc -g 3：生成doc目录 例子：apidoc -i ~/Tools/apidoc-master/ -o doc/ 格式: apidoc -i myapp/ -o apidoc/ -t mytemplate/ -
Laravel使用Apidoc注解自动生成Api接口文档
qq_25243841的博客
11-15 1579
本教程从零开始搭建laravel项目，并安装Apidoc扩展及使用注解生成Api接口文档的教程，该扩展支持 多应用/版本、Markdown文档、在线接口调试、接口生成器、代码模板生成器、Mock调试数据、调试事件、授权访问等非常多的功能
Apidoc的安装配置及使用
lightserver.cn
12-18 2087
Apidoc的安装配置及使用Apidoc的安装配置及使用1.什么是Apidoc2.友好的文档展示页面3.注释生成接口文档的原理4.Apidoc安装 Apidoc的安装配置及使用 你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。 1.什么是Apidoc Apidoc是一款可...
concurrency编程—对象头组成
weixin_43206829的博客
11-23 68
提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录Synchronized锁升级一、pandas是什么？二、使用步骤1.引入库2.读入数据总结 Synchronized锁升级 提示：这里可以添加本文要记录的大概内容： 例如：随着人工智能的不断发展，机器学习这门技术也越来越重要，很多人都开启了学习机器学习，本文就介绍了机器学习的基础内容。 提示：以下是本篇文章正文内容，下面案例可供参考 一、pandas是什么？ 示例：pandas 是基于NumPy 的一种工具，该工具是为了解决数
laravel apidoc工具使用
Martian
02-28 3939
apidoc是一种风格优雅的API文档生成工具。 第一步：安装nodejs curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash - sudo apt-get install -y nodejs 注意：此处需要下载一个依赖工具： sudo apt-get install -y build-essential 查看是否安
Laravel API Docs 安装
qq_26987043的博客
04-25 758
Laravel API Docs GeneratorThis Laravel package provides an API Documentation generator based upon your Routes and Controller Method DocBlock comments.InstallationLaravel 5.0Begin by installing this pa...
php apidoc生成软件,使用 Laravel API 文档生成器扩展包自动为项目生成 API 文档
weixin_36369259的博客
03-23 178
1、简介&安装Laravel API 文档 生成器 扩展包可以基于 Laravel 应用路由自动生成项目 API 文档。我们使用Composer安装这个扩展包： $ composer require mpociot/laravel-apidoc-generator安装完成后需要到 config/app.php 中注册服务提供者： Mpociot\ApiDoc\ApiDocGen...
APIDOC node
最新发布
08-30
APIDOC是一个用于生成RESTful API文档的工具，它可以从代码注释中提取特定格式的内容生成文档。它支持多种开发语言，如GO、Java、C、Rust等。使用APIDOC可以方便地为后端代码编写接口文档，并且可以自动生成文档。在Node.js项目中使用APIDOC，你需要新建一个文件夹来存放生成的文档，并在项目的启动文件（如app.js）中添加相应的配置，示例代码如下：app.use('/apidoc存放的位置',express.static('apidoc存放的位置'));其中，'apidoc存放的位置'是你存放APIDOC生成的文件的路径，通过访问相应的URL地址，即可自动运行生成的API文档。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [Node与apidoc的邂逅——NodeJS Restful 的API文档生成](https://blog.csdn.net/weixin_33953249/article/details/93345878)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* *3* [APIDOC- API文档生成工具——node](https://blog.csdn.net/mantou_riji/article/details/125697962)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值