在laravel 5.6 中如何使用swagger

2022-05-15 0 556

在laravel 5.6 中如何使用swagger

在laravel 5.6 中使用swagger

写本篇文章时,本人laravel版本为5.6.28

安装

composer require darkaonline/l5-swaggerUsing version ^5.6 for darkaonline/l5-swagger...  - Installing swagger-api/swagger-ui (v3.17.4)  - Installing doctrine/annotations (v1.6.0)  - Installing zircote/swagger-php (2.0.13)  - Installing darkaonline/l5-swagger (5.6.5)...

运行

php artisan vendor:publish

选择L5Swagger\\L5SwaggerServiceProvider这项
这时会添加两个文件

/config/l5-swagger.php/resources/views/vendor/l5-swagger/index.blade.php

配置

app/Http/Controllers/Controller.php文件中class前添加注释

<?phpnamespace App\\Http\\Controllers;use Illuminate\\Foundation\\Bus\\DispatchesJobs;use Illuminate\\Routing\\Controller as BaseController;use Illuminate\\Foundation\\Validation\\ValidatesRequests;use Illuminate\\Foundation\\Auth\\Access\\AuthorizesRequests;/** * @SWG\\Swagger( *   basePath="/calculate-rates", *   @SWG\\Info( *     title="项目名称 API", *     version="1.0.0" *   ) * ) */class Controller extends BaseController{    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;}

运行命令

php artisan l5-swagger:generate

打开你的项目网址http://localhost/api/documentation,你会看到swagger已经运行成功了,但是没有显示任何API文档。

编写文档

http://localhost/home 示例:
HomeControllerindex方法上面编写文档

/**     * @SWG\\Get(     *   path="/home",     *   summary="用户资料",     *   @SWG\\Response(response=200, description="请求成功"),     *   @SWG\\Response(response=401, description="用户验证失败"),     *   @SWG\\Response(response=500, description="服务器错误")     * )     *     */    public function index()    {        return view('home');    }

再次运行命令

php artisan l5-swagger:generate

回到http://localhost/api/documentation中刷新,文档就已经出来了,应该是长这个样子
在laravel 5.6 中如何使用swagger

推荐:最新的五个Laravel视频教程

收藏 (0) 打赏

感谢您的支持,我会继续努力的!

打开微信/支付宝扫一扫,即可进行扫码打赏哦,分享从这里开始,精彩与您同在
点赞 (0)

【声明:根据2013年1月30日《计算机软件保护条例》2次修订第17条规定: 为了学习和研究软件内含的设计思想和原理,通过安装、显示、传输或者存 储软件等方式使用软件的,可以不经软件著作权人许可,不向其支付报酬! 鉴于此,也希望大家按此说明研究软件!】
本站所有源码尽量保证原汁原味,如有特殊情况会作出声明及标注,网站资源不做任何二次加密(原版加密除外,不影响程序使用的不会做解密处理),方便您更好的学习参考。 在您的能力范围内,为了大环境的良性发展,请尽可能的选择正版资源。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。

即刻码站__国内靠谱的站长资源下载平台 php教程 在laravel 5.6 中如何使用swagger https://www.jike1995.com/36497.html

常见问题
  • 本站所有资源版权均属于原作者所有,这里所提供资源均只能用于参考学习用,请勿直接商用。若由于商用引起版权纠纷,一切责任均由使用
查看详情
  • 最常见的情况是下载不完整: 可对比下载完压缩包的与网盘上的容量,若小于网盘提示的容量则是这个原因。这是浏览器下载的bug,建议用百度
查看详情

相关文章

发表评论
暂无评论
官方客服团队

为您解决烦忧 - 24小时在线 专业服务