Laravel apiDoc配置

秦楚
2023-12-01

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

 类似资料: