Laravel 使用 Swagger -1

想Laravel 使用 Swagger ,首先在Laravel安裝Swagger ,在這使用的是darkaonline/l5-swagger
參考套件: https://github.com/DarkaOnLine/L5-Swagger/wiki/Installation-&-Configuration

Setp1 安裝套件
composer require "darkaonline/l5-swagger"
Setp2 註冊套件

如果Laravel版本小於5.5,需要宣告套件的註冊使用

方法一:
在app/Providers/AppServiceProvider.php中的register,添加以下

$this->app->register(\L5Swagger\L5SwaggerServiceProvider::class);

或者

方法二
在config/app.php中的providers,添加如下

L5Swagger\L5SwaggerServiceProvider::class,
Setp3 發佈設定檔

發佈設定檔

php artisan vendor:publish –provider “L5Swagger\L5SwaggerServiceProvider

此時打開YourUrl+/api/documentation,就會看到文件了,但因為都還沒撰寫,所以顯示錯誤是正常的。

Setp4 修設定檔

發佈了設定,在Config中會發現多了一個l5-swagger.php,這是SWAGER的設定檔
裡面大部分是預設值,不修改不影響使用。

比較常用到的參數是,我們開啟網頁的URL網址,設定哪個網址看SWAGER API 文件。
預設值是 YourUrl+/api/documentation,我們可以依自己喜好修改。

'routes' => [
	/*
	 * Route for accessing api documentation interface
	*/
	'api' => 'api/documentation',
],

譬如我修改成 /doc

'routes' => [
	/*
	 * Route for accessing api documentation interface
	*/
	'api' => 'doc',
],

此時開啟YourUrl + /doc 就可以看到了Swagger文件網站了。

其他就沒什麼修改過,所以我這就跳過,不說明了,檔案中都有英文備註,再自行參考。

以上這樣就安裝完成了。

發佈留言

發佈留言必須填寫的電子郵件地址不會公開。 必填欄位標示為 *