博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Swagger在Laravel项目中的使用
阅读量:4293 次
发布时间:2019-05-27

本文共 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.*" 
等待安装结束。 
之后执行:

  • Run php artisan l5-swagger:publish 来进行初始化
  • Run php artisan l5-swagger:generate 来生成环境变量到.env文件中

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

è¿éåå¾çæè¿°

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

è¿éåå¾çæè¿°

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

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

è¿éåå¾çæè¿°

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


附上Swagger-PHP的demo地址,可以参照其中的示例。 

你可能感兴趣的文章
第一天上班没精神
查看>>
启动eclipse报错:Failed to load the JNI shared library
查看>>
eclipse安装插件的两种方式在线和离线
查看>>
linux下源的相关笔记(suse)
查看>>
linux系统分区文件系统划分札记
查看>>
Linux(SUSE 12)安装Tomcat
查看>>
Linux(SUSE 12)安装jboss4并实现远程访问
查看>>
Neutron在给虚拟机分配网络时,底层是如何实现的?
查看>>
netfilter/iptables全攻略
查看>>
Overlay之VXLAN架构
查看>>
Eclipse : An error occurred while filtering resources(Maven错误提示)
查看>>
在eclipse上用tomcat部署项目404解决方案
查看>>
web.xml 配置中classpath: 与classpath*:的区别
查看>>
suse如何修改ssh端口为2222?
查看>>
详细理解“>/dev/null 2>&1”
查看>>
suse如何创建定时任务?
查看>>
suse搭建ftp服务器方法
查看>>
centos虚拟机设置共享文件夹并通过我的电脑访问[增加smbd端口修改]
查看>>
Socket深度探究4PHP(三)
查看>>
可继承扩展的单例实现
查看>>