如何在Laravel 5.6中利用Swagger实现长尾词功能？

2026-04-18 10:112阅读0评论SEO资讯
  • 内容介绍
  • 文章标签
  • 相关推荐

本文共计564个文字，预计阅读时间需要3分钟。

如何在Laravel 5.6中利用Swagger实现长尾词功能？

由 Laravel 教程栏目为新手介绍在 Laravel 5.6 中使用 Swagger，希望对需要的朋友有所帮助！在 Laravel 5.6 中使用 Swagger，本文以 5.6.28 版本为例，通过 composer 安装 darkaonline/l 包。

在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

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

编写文档

拿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

回到localhost/api/documentation中刷新，文档就已经出来了，应该是长这个样子

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

以上就是在laravel 5.6 中如何使用swagger的详细内容，更多请关注自由互联其它相关文章！

如何在Laravel 5.6中利用Swagger实现长尾词功能？