本文共 1009 字,大约阅读时间需要 3 分钟。
本篇讲述在如何快速在Laravel中引入Swagger并开始使用。
首先是使用Laravel的一个composer:L5 Swagger
。
Laravel | Swagger UI | OpenAPI Spec compatibility | L5-Swagger |
---|---|---|---|
5.1.x | 2.2 | 1.1, 1.2, 2.0 | php composer require “darkaonline/l5-swagger:~3.0” |
5.2.x | 2.2 | 1.1, 1.2, 2.0 | php composer require “darkaonline/l5-swagger:~3.0” |
5.3.x | 2.2 | 1.1, 1.2, 2.0 | php composer require “darkaonline/l5-swagger:~3.0” |
5.4.x | 2.2 | 1.1, 1.2, 2.0 | php composer require “darkaonline/l5-swagger:~3.0” |
5.4.x | 3 | 2.0 | php composer require “darkaonline/l5-swagger:5.4.*” |
5.5.x | 3 | 2.0 | php composer require “darkaonline/l5-swagger:5.5.*” |
下面的过程全部基于Laravel 5.5.x
在Laravel根目录下执行一下命令composer require "darkaonline/l5-swagger:5.5.*"
等待安装结束。 之后执行: php artisan l5-swagger:publish
来进行初始化php artisan l5-swagger:generate
来生成环境变量到.env文件中现在可以看到在config
目录下有一个l5-swagger.php
,里面就是对应swagger的各个配置。
然后启动项目,访问你的网站地址/api/documentation
就可以看到初始化界面了。
接下来在控制器中写出一个SwaggerController,其中代码如下:
这是再访问http://localhost/api/documentation
,可以看到以下画面:
现在,开始尽情使用Swagger吧。
附上Swagger-PHP的demo地址,可以参照其中的示例。