個人寫的一個小工具 laravel生成介面文件

by159147發表於2020-09-17
Laravel

  • 寫文件非常浪費後端同學的時間

  • 自動讀取 request 的驗證規則和方法註釋作為請求引數

  • 讀取attributes,validation.php,資料庫欄位欄位作為註釋

  • 提供中介軟體儲存返回會自動的生成相關文件

  1. 安裝

      composer require faed/laravle-doc

  2. 釋出配置

      php artisan vendor:publish

  3. 配置

    return [ //版本
  'v'=>1,
//名稱
  'name'=>env('APP_NAME'),
//app名稱
  'app_name'=>env('APP_NAME'),
//請求地址
  'path'=>env('APP_URL'),
//介面地址傳送地址
  'send'=>'http://127.0.0.1:8000',
//路由過濾
  'only'=>'api',
//laravle版本 7.8路由方式不一樣預設８請自行定義
  'laravle_versions'=>8,
//自動讀取資料庫的欄位註釋作為註釋，多庫請自行定義
  'mysql' => ['mysql'],
];

  4. 執行遷移檔案生成相關的表

      php artisan migrate 　

  5. 執行 自動生成相關的文件資料路由　xxxxx/doc

      php artisan api:make

類註釋自動分組,控制器

/**
 * @group 介面
 * @package App\Http\Controllers */
/**
 * 說明
 * @q size Y 大小
 * @u page N 分頁
 * @b body Y 引數
 */
  1. xxxxx/doc 路由

image

image

  1. 提供中介軟體[ RecordReturn ]記錄返回資料,請自行新增

      [
        'throttle:api',
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        RecordReturn::class,
 ];

  1. 讀取資料庫時需要的時間可能較長提供引數選擇

      php artisan api:make -MC

    ps:可以作為一個專案多個版本的管理,或者單獨佈置多個專案介面管理

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章