您好,欢迎访问一九零五行业门户网

在laravel 5.6 中如何使用swagger

下面由laravel教程栏目给大家介绍在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前添加注释
运行命令
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视频教程
以上就是在laravel 5.6 中如何使用swagger的详细内容。
其它类似信息

推荐信息