Laravel 文檔自動生成器

mpociot/laravel-apidoc-generator

也可以關注我的個人博客

簡介&安裝

Laravel API 文檔生成器擴展包可以基于 Laravel 應用路由自動生成項目 API 文檔。

我們使用Composer安裝這個擴展包

composer require mpociot/laravel-apidoc-generator

安裝完成后需要到config/app.php中注冊服務提供者：

Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class,

基本使用

基礎示例

下面我們來演示如何使用這個擴展包自動為項目生成API文檔，其原理是通過掃描api.php為指定路由生成相應API文檔，比如我們的路由文件定義了一個路由如下：

Route::get('/category/test','CategoryController@category_test');

控制器的方法如下：

/**
 * API首頁
 *
 * 歡迎來到Laravel學院，Laravel學院致力于提供優質Laravel中文學習資源
 *
 */
    public function category_test(TestRequest $request){
        $taxonomy = CategoryTaxonomy::where('term_taxonomy_id',24)->first()->terms->first();

        return $taxonomy;

    }
    

然后執行：
php artisan api:generate --routePrefix="api/category/test"

前臺打開 http://your_web_site/docs/查看為如下結果

前臺API頁面

帶參數的請求api示例

我們還是已上面的路由為例，首先創建一個請求
php artisan make:request TestRequest

然后在請求的中寫參數：

    public function rules()
    {
        return [

            'title' => 'red|max:255',
            'body' => '',
            'type' => 'in:foo,bar',
            'thumbnail' => 'required_if:type,foo|image',

        ];
    }

控制器代碼如下：

    /**
     * API請求參數
     *
     * @param App\Http\Requests\TestRequest $request
     *
     *
     */
    public function category_test(TestRequest $request){
        $taxonomy = CategoryTaxonomy::where('term_taxonomy_id',24)->first()->terms->first();

        return $taxonomy;

    }
    

前臺打開 http://your_web_site/docs/查看為如下結果

前臺API頁面

以上就是基本的laravel 文檔生成工具的基本使用，歡迎關注我的簡書，不定期分享技術文檔。
??附上地址mpociot