l5-swagger的安装使用

最新推荐文章于 2024-08-22 08:56:06 发布

Z_xugaaa

最新推荐文章于 2024-08-22 08:56:06 发布

阅读量1.7k

点赞数

分类专栏： PHP 文章标签： Laravel Swagger

本文链接：https://blog.csdn.net/qq_43143808/article/details/94399673

版权

PHP 专栏收录该内容

7 篇文章 0 订阅

订阅专栏

安装

https://packagist.org/packages/darkaonline/l5-swagger

在该网页上根据所laravel版本选择swagger版本

composer require darkaonline/l5-swagger:x.x.x

运行

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已经运行成功了，

如果需要开启自动生成，可在配置文件中设置generate_always参数为true

  'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', true),

在config\l5-swagger.php文件中

title 设置页面标题

'api' => [
        /*
        |--------------------------------------------------------------------------
        | Edit to set the api's title
        |--------------------------------------------------------------------------
        */

        'title' => 'L5 Swagger UI',
    ],

routes下面的分别是

访问API文档接口的路径

用于访问已分析的Swagger注释的路由

OAuth2身份验证回调的路由

'routes' => [
        /*
        |--------------------------------------------------------------------------
        | Route for accessing api documentation interface
        |--------------------------------------------------------------------------
        */

        'api' => 'api/documentation',

        /*
        |--------------------------------------------------------------------------
        | Route for accessing parsed swagger annotations.
        |--------------------------------------------------------------------------
        */

        'docs' => 'docs',

        /*
        |--------------------------------------------------------------------------
        | Route for Oauth2 authentication callback.
        |--------------------------------------------------------------------------
        */

效果图：