您好,登录后才能下订单哦!
这篇文章主要介绍在laravel 5.6 中怎样使用swagger,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!
Laravel 是一套简洁、优雅的PHP Web开发框架。它可以让你从面条一样杂乱的代码中解脱出来;它可以帮你构建一个完美的网络APP,而且每行代码都可以简洁、富于表达力。
在laravel 5.6 中使用swagger
写本篇文章时,本人laravel版本为5.6.28
composer require darkaonline/l5-swagger Using 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
前添加注释
<?php namespace 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
示例:
在HomeController
的index
方法上面编写文档
/** * @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”这篇文章的所有内容,感谢各位的阅读!希望分享的内容对大家有帮助,更多相关知识,欢迎关注亿速云行业资讯频道!
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。