頂部導航開始 -->

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號
  • 聯系郵箱:[email protected]
  • 交流請加微信:weibobf2899 或掃下方二維碼
双大床红利扑克1手APP