Laravel 安装Swagger

唔系我认叻 - 2021-09-15 23:44:39

一、Swagger是什么
Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

二、Swagger安装

composer require "darkaonline/l5-swagger"

三、配置
安装成功后Laravel配置
在app/Providers/AppServiceProvider 添加

$this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);

或者
在config/app.php 添加

L5Swagger\L5SwaggerServiceProvider::class,

在app\Http\Controllers\Controller.php 写上swagger初始代码（如果不写启动swagger会报错）

/**
 * @OA\Info(title="KIDSERVICE", version="0.1")
 *
 */
class Controller extends BaseController

Laravel发布swagger

 php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

启动运行（每次修改swagger代码都要重新用这个命令刷新运行）
php artisan l5-swagger:generate

浏览器地址栏输入 “域名”+ /api/documentation

效果图

四、总结
优点
Swagger 充当一个RESTful api单元测试，文档注释的作用。在企业前后端分离api功能测试、后端开发团队人员快速知道函数方法和参数所表达的意思和意图。
缺点：
Swagger 有自己一套解释语言，所以等于重新学习一个解释语言（难度不大）；会耗费一些开发效率，这等于写一套单元测试和注释。

特别申明：本文内容来源网络，版权归原作者所有，如有侵权请立即与我们联系（cy198701067573@163.com），我们将及时处理。