Laravel5.5.x集成Swagger (L5-Swagger) 只讲Laravel5.5.x的集成,laravel其他版本请自行研究或参考github上的说明

--------上图 截取自Github 官网上的安装参考-----------------------------------------------------------------------------------------------------------------------------------------------------------

本人只用到了Laravel5.5.x, 所以只讲此版本的安装,所有步骤如下

①步骤1:

在你搭建的laravel项目根目录中执行命令:  composer require "darkaonline/l5-swagger:5.5.*"

②步骤2:

继续在项目根目录中执行命令: php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

执行该命令后,会在config目录下产生一个l5-swagger.php的配置文件,里面包含了swagger标题,token验证,路由等常用的基本配置
其中’generate_always’配置可以根据需要修改下,它表示是否每次都刷新swagger, 示例如下:

'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', false),        //  把false改为true,你每次修改了配置它就会马上更新, 否则你更改了配置它不会马上生效

③步骤3:

在项目根目录中执行命令: composer require 'zircote/swagger-php:2.*'

然后启动项目,浏览器访问测试:你的网站地址/api/documentation 可以看到swagger的界面了,但会提示缺少api-docs.json文件。 

需在项目app下创建个php文件(注意:是直接放在app文件夹下,不是放在htpp下,也不是放在http的Controllers文件夹下),命名为:swagger.php  文件内容如下:

④步骤4:在项目根目录中执行命令: php artisan l5-swagger:generate           // 如果上面不创建swagger.php 如果执行此命令就会抛出错误:  In Logger.php line 38: Required @SWG\Info() not found    切忌!

现在重新访问 你的网站地址/api/documentation 刷新swagger就可以了 如图:

猜你喜欢

转载自www.cnblogs.com/jiang-xy/p/9560095.html