Cara membuat dokumentasi di aplikasi laravel

undefined

Mengembangkan aplikasi web dengan menggunakan laravel akan membantu kita untuk mempercepat proses pengerjaanya.

Salah satunya adalah membuat dokumentasi dari aplikasi yang kita kembangkan. Dokumentasi ini bisa untuk dokumentasi api, atau bagian yang lain yang penting untuk di dokumentasikan.

Dokumentasi yang dibuat juga bisa dibuat open untuk public atau tidak. Nah bagaimana caranya? Mari ikuti tahap - tahap berikut ini untuk membuat dokumentasi pada aplikasi laravel kamu.

Pengenalan LaRecipe

Kali ini kita bahas package LaRecipe. Apa itu LaRecipe?

LaRecipe adalah package aplikasi laravel yang berguna untuk membuat halaman dokumentasi berbasik markdown.

Sudah tau markdown belum? Ok deh buat kamu yang belum tau kita bahas dikit.

Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML. Wikipedia

Intinya markown ini adalah sebuah format file yang dapat di convert atau di tampilkan kedalam format lain salah satunya html.

Misalnya jika kita menulis dalam html adalah seperti ini.

<h1>Hello i'm heading 1</h1>
<h2>Hello i'm heading 2</h2>
<h3>Hello i'm heading 3</h3>

Nah kalau kita menulis dalam bentuk format markdown seperti berikut ini.

# Hello i'm headi 1
### Hello i'm headi 2
### Hello i'm headi 3

Nah nantinya ketika di proses dari format markdown ini nanti bisa menjadi html seperti contoh di atas.

Markdown ini sangat cocok sekali jika kita ingin menulis deskripsi, atau digunakan untuk menulis artikel blog post.

Dan jika untuk membuat dokumentasi ini sangat bisa dan mudah sekali. Karena kita tidak perlu menyimpan filenya di database.

Penggunaan LaRecipe

OK tadi kita sudah kenalan dikit dengan markdown, yang mana sebauh teknologi yang di manfaatkan oleh package LaRecipe untuk format data yang akan di proses menjadi html.

Sekarang mari kita tambahkan package LaRecipe ke project kita.

composer require binarytorch/larecipe

Sudah selesai menambahkan package melalui composer sekarang kita lanjutkan ke installasi larecipe ini.

Untuk menginstall larecipe jalankan perintah berikut ini.

php artisan larecipe:install

Jika sudah sekarang kamu bisa coba buka url berikut ini.

http://127.0.0.1:8000/docs/1.0/overview

Nah kira - kira tampilanya adalah seperti berikut ini.

undefined

Nah sekarang kamu bisa mulai menulis dengan markdown.

Bonus

Untuk menulis file markdownya bisa di taruh pada folder resource/docs.

Kalau kamu ingin dokumentasi ini tidak bisa di akses public maka kamu bisa aktifkan auth nya.

Silahkan buka config fila pada app/config/larecipe.php.

  'settings' => [
    'auth' => true,
    'ga_id' => ''
  ],

Nah sekian dulu semoga artikel ini bermanfaat sampai jumpa pada artikel berikutnya.