使用 Enlighten 自動化產生 Laravel API 文件,提高開發效率

前言

API 文件是開發中很重要的一環,它可以讓開發者們更好的了解怎麼使用 API。但是維護和更新 API 文件對後端開發者來說可能會很麻煩。隨著時間的過去,API 的版本會不斷變化,開發者則需要花時間維護最新版本。

以下會介紹 Enlighten ,可以自動產生 Laravel API 的文件,不需要手動維護文件。這個套件可以從測試中自動產生 API 文件,確保文件與 API 的最新版本同步,讓開發者有更多時間去開發和改善 API,進而讓開發更有效率。

Enlighten

套件
https://github.com/StydeNet/enlighten

安裝

1
2
composer require styde/enlighten --dev
php artisan enlighten:install

產生文件

1
php artisan enlighten

瀏覽 API 文件
http://localhost/enlighten/