顶部导航开始 -->

Swagger在Laravel项目中的使用

本篇讲述在如何快速在Laravel中引入Swagger并开始使用。

安装

github地址: https://github.com/darkaonline/l5-swagger

首先是使用Laravel的一个composer:L5 Swagger。 
下面是对应的各个版本。

LaravelSwagger UIOpenAPI Spec compatibilityL5-Swagger
5.1.x2.21.1, 1.2, 2.0php composer require “darkaonline/l5-swagger:~3.0”
5.2.x2.21.1, 1.2, 2.0php composer require “darkaonline/l5-swagger:~3.0”
5.3.x2.21.1, 1.2, 2.0php composer require “darkaonline/l5-swagger:~3.0”
5.4.x2.21.1, 1.2, 2.0php composer require “darkaonline/l5-swagger:~3.0”
5.4.x32.0php composer require “darkaonline/l5-swagger:5.4.*”
5.5.x32.0php composer require “darkaonline/l5-swagger:5.5.*”


下面的过程全部基于Laravel 5.5.x 

在Laravel根目录下执行一下命令 

composer require "darkaonline/l5-swagger:5.5.*" 

等待安装结束。 

之后执行:

composer require zircote/swagger-php:2.*
php artisan l5-swagger:generate 来生成环境变量到.env文件中
php artisan vendor:publish 选择[6 ] Provider: L5Swagger\L5SwaggerServiceProvider
[6 ] Provider: L5Swagger\L5SwaggerServiceProvider
vendor:publish来进行初始化
vendor:publish
vendor:publish

现在可以看到在config目录下有一个l5-swagger.php,里面就是对应swagger的各个配置。

自学php博客


然后启动项目,访问你的网站地址/api/documentation就可以看到初始化界面了。

自学php博客

接下来在控制器中写出一个SwaggerController,其中代码如下:

这是再访问http://localhost/api/documentation,可以看到以下画面:

自学php博客


现在,开始尽情使用Swagger吧。


自学php博客
请先登陆后发表评论
  • 最新评论
  • 总共0条评论
  • © 2014-2016 zixuephp.cn 版权所有
  • ICP证:皖ICP备16012107号
  • 联系邮箱:510082587@qq.com
  • 交流请加微信:weibobf2899 或扫下方二维码