关于php:Laravel-安装Swagger

1次阅读

共计 773 个字符,预计需要花费 2 分钟才能阅读完成。

一、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 有本人一套解释语言,所以等于重新学习一个解释语言(难度不大);会消耗一些开发效率,这等于写一套单元测试和正文。

正文完
 0