Ada kalanya dimana kita harus membagikan dan menjelaskan api atau route yang sudah kita buat di project laravel kepada misalnya front-end developer yang tidak punya pengetahuan tentang api yang kita buat, seperti kebutuhan parameter, struktur request dan response, dan kebutuhan body ketika post. Lalu kita sebagai backend-developer harus membuat dokumentasi entah di postman atau package pembuat dokumentasi route lainnya, harus mengubah dan memperbarui setiap dari route tersebut ketika ada perubahan misalnya response structure, requirement request body ketika post, dan lain-lain. Sangat melelahkan bukan?

Laravel Request Docs

Salah satu kelebihan yang dimiliki laravel adalah komunitasnya yang luas dan menyediakan banyak sekali third-party-package yang bisa digunakan oleh pengguna laravel secara luas. Dan salah satu dari banyaknya package tersebut ada Laravel Request Docs yang membiarkan developer untuk mendokumentasikan route yang ada di project laravel mereka hanya dalam beberapa menit tanpa konfigurasi.

Jalankan perintah berikut untuk mengunduh package yang dibutuhkan:

composer require rakutentech/laravel-request-docs --dev

Selanjutnya, jalankan perintah dibawah untuk publish config kedalam file config:

php artisan vendor:publish --tag=request-docs-config

Dan tahap terakhir adalah untuk mengenerate file html static dan spesifikasi open api dengan menjalankan perintah berikut:

php artisan lrd:generate
php artisan optimize

Dan bila kita pergi ke endpont /request-docs, kita akan disajikan dengan halaman yang berisi semua route yang sudah didaftarkan lengkap dengan testing panel.

Semoga artikel ini bisa membawa manfaat, bila ingin membaca dokumentasi lengkapnya, bisa kunjingin link ini.

Terimakasih!