Laravel 文檔自動(dòng)生成器
mpociot/laravel-apidoc-generator
也可以關(guān)注我的個(gè)人博客
簡(jiǎn)介&安裝
Laravel API 文檔生成器擴(kuò)展包可以基于 Laravel 應(yīng)用路由自動(dòng)生成項(xiàng)目 API 文檔谤逼。
我們使用Composer安裝這個(gè)擴(kuò)展包
composer require mpociot/laravel-apidoc-generator
安裝完成后需要到config/app.php中注冊(cè)服務(wù)提供者：
Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class,
基本使用
基礎(chǔ)示例
下面我們來演示如何使用這個(gè)擴(kuò)展包自動(dòng)為項(xiàng)目生成API文檔瑰剃，其原理是通過掃描api.php為指定路由生成相應(yīng)API文檔，比如我們的路由文件定義了一個(gè)路由如下：
Route::get('/category/test','CategoryController@category_test');
控制器的方法如下：
/**
* API首頁
*
* 歡迎來到Laravel學(xué)院沉御，Laravel學(xué)院致力于提供優(yōu)質(zhì)Laravel中文學(xué)習(xí)資源
*
*/
public function category_test(TestRequest $request){
$taxonomy = CategoryTaxonomy::where('term_taxonomy_id',24)->first()->terms->first();
return $taxonomy;
}
然后執(zhí)行：
php artisan api:generate --routePrefix="api/category/test"
前臺(tái)打開 http://your_web_site/docs/查看為如下結(jié)果
前臺(tái)API頁面
帶參數(shù)的請(qǐng)求api示例
我們還是已上面的路由為例硅堆，首先創(chuàng)建一個(gè)請(qǐng)求
php artisan make:request TestRequest
然后在請(qǐng)求的中寫參數(shù)：
public function rules()
{
return [
'title' => 'red|max:255',
'body' => '',
'type' => 'in:foo,bar',
'thumbnail' => 'required_if:type,foo|image',
];
}
控制器代碼如下：
/**
* API請(qǐng)求參數(shù)
*
* @param App\Http\Requests\TestRequest $request
*
*
*/
public function category_test(TestRequest $request){
$taxonomy = CategoryTaxonomy::where('term_taxonomy_id',24)->first()->terms->first();
return $taxonomy;
}
前臺(tái)打開 http://your_web_site/docs/查看為如下結(jié)果
前臺(tái)API頁面
以上就是基本的laravel 文檔生成工具的基本使用屿储，歡迎關(guān)注我的簡(jiǎn)書，不定期分享技術(shù)文檔渐逃。
??附上地址mpociot
