擴充套件包 Laravel-compass 使用筆記

lxzoliver發表於2020-02-27
套件Laravel筆記

由於前幾天剛翻譯了關於laravel-compass擴充套件文章，對於此擴充套件包有很大的興趣，該擴充套件包可以根據laravel專案的路由自動生成對應的API測試呼叫方法(類似Postman)和API文件。當然具體介紹可以檢視davidhsianturi/laravel-compass

如何使用該擴充套件包

通過composer引入該擴充套件包

composer require davidhsianturi/laravel-compass –dev

然後使用命令:

php artisan compass:install

此命令在config目錄下生成compass.php配置檔案

return [
    /*
    |--------------------------------------------------------------------------
    | Compass Path
    |--------------------------------------------------------------------------
    |
    | 這是訪問compass的路由路徑，你可以根據自己的喜好修改路由路徑 
    |
    */

    'path' => env('COMPASS_PATH', 'compass'),

    /*
    |--------------------------------------------------------------------------
    | Laravel Routes
    |--------------------------------------------------------------------------
    |
    | 這是將為請求列表過濾的路由規則。使用*作為萬用字元以匹配任何字元。
    | 注意以下陣列“exclude”必須由路由名稱引用。
    | “ base_uri”是一個字串值，用於對路由進行分組比較。
    |
    */

    'routes' => [
        'domains' => [
            '*',
        ],

        'prefixes' => [
            '*',
        ],

        'exclude' => [
            'compass.*',
            'debugbar.*',
        ],

        'base_uri' => '*',
    ],

    /*
    |--------------------------------------------------------------------------
    | Compass Storage Driver
    |--------------------------------------------------------------------------
    |
    | 此配置選項決定了儲存驅動程式，它將用於儲存您的API呼叫和路由。
    | 此外，您可以選擇特定驅動程式。
    |
    */

    'driver' => env('COMPASS_DRIVER', 'database'),

    'storage' => [
        'database' => [
            'connection' => env('DB_CONNECTION', 'mysql'),
        ],
    ],

    /*
    |--------------------------------------------------------------------------
    | API Documentation Builder
    |--------------------------------------------------------------------------
    |
    | Compass will write and build contents in Documentarian markdown files
    | and as a generator to generate the API documentation which is a
    | PHP port of the popular Slate API documentation tool.
    | Compass將在Documentarian中編寫和構建markdown檔案並生成API文件
    | @see https://github.com/mpociot/documentarian
    |
    */

    'builder' => 'slate',

    'template' => [
        'slate' => [
            'output' => 'public/docs',
            'example_requests' => [
                'bash',
            ],
        ],
    ],
];

並在public/vendor/compass/生成相應的前端資源。

執行php artisan migrate命令執行遷移，該命令將執行資料庫遷移生成compass_routeables表，用於記錄測試路由資料

執行php artisan compass:publish命令,該命令將釋出compass所需要的前端檔案

如果你沒有修改配置路由，可通過yourproject.test/compass訪問laravel compass介面

擴充套件包 Laravel-compass 使用心得

可在該介面對相關的API進行測試並儲存API的相關資訊，在團隊開發API時，該擴充套件包可以更好的上手測試瞭解相關的API並儲存文件。

可執行php artisan compass:build生成相應的API文件，命令執行完成後，可通過yourproject.test/docs/index.html訪問文件頁面，可對API進行搜尋並檢視

擴充套件包 Laravel-compass 使用心得

總結

該擴充套件包還是十分方便的，對於之前專案中，沒有進行API文件編寫，也可以通過擴充套件包進行文件補充說明，在團隊開發過程中，讓其他人更加容易上手瞭解API。

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

相關文章