Cara Mudah Membuat API Documentation Dengan LareCipe
Software Engineer | Blogger | Creator of RubyPedia.com
19 November 2019

Halo teman-teman semuanya, pada kesempatan kali ini saya akan membagikan pengalaman saya membuat sebuah Api Documentation.

Dari 2 hari lalu setelah artikel ini dibuat, saya mencoba membuat Api Documentation untuk mempermudah teman saya di bagian Android Developer dan Front-End Developer di kantor.

Saya mencoba template HTML untuk mulai membuat Api Documentation, tapi setelah difikir-fikir akan sangat lama jika menggunakan HTML untuk mengembangkannya.

Kemudian saya mencoba mencari lebih dalam lagi, dan ketemulah dengan sebuah Static Api Documentation generator dengan hanya menggunakan Markdown.


Yups, namanya adalah LareCipe, yaitu sebuah Static Api Documentation yang menggunakan beberapa Vue JS Component, enaknya lagi LareCipe ini menggunakan Markdown yang langsung di generate menjadi sebuah tampilan yang sangat elegan sekali.

LareCip juga sudah menggunakan TailwindCSS sebagai Framework CSSnya yang artinya Larecipe ini menggunakan normalise.css dan ini sangat membantu sekali.

Beberapa fitur-fitur yang ada di LareCipe diantaranya:

  1. MarkDown Support LaRecipe secara otomatis memanfaatkan Markdown ke parser HTML di luar kotak termasuk tipografi, gambar, tautan, dan lainnya

  2. Vue Components LaRecipe menyediakan banyak komponen berbasis UI Vue yang terlihat menakjubkan karena fakta ini mengkompilasi dokumentasi penurunan harga di bagian belakang ke HTML

  3. Search Support Jika Anda memiliki dokumentasi yang sangat besar, sangat berguna untuk menyediakan fungsi pencarian sehingga pengguna Anda dapat menemukan kebutuhan mereka dengan cepat.

  4. Versioning LaRecipe memudahkan untuk memiliki beberapa versi untuk dokumen Anda, memungkinkan Anda menentukan versi yang diterbitkan dan yang standar.

  5. Google Analytics Perlu untuk melacak kunjungan dokumentasi Anda? Tidak masalah. Tambahkan ID Google Analytics Anda di konfigurasi dan Anda siap untuk pergi.

  6. Authorization Selain menyediakan fitur otentikasi di luar kotak, LaRecipe juga menyediakan cara sederhana untuk mengotorisasi akses pengguna terhadap dokumentasi yang diberikan.

Cara Install LareCipe via composer

composer require binarytorch/larecipe

Setelah berhasil terinstall, selanjutnya jalankan perintah

php artisan larecipe:install

Setelah teman-teman menjalankan perintah diatas, maka secara otomatis si LareCipe akan membuat sebuh file di config/larecipe.php.

Silahkan disesuaikan dengan kebutuhan masing-masing, jika kalian ingin menggubahwarna, mengaaktifkan disqus, auth, dan lain-lain, kalian bisa membuat di dalam file config/larecipe.php.

Untuk melihat hasilnya

  1. Jika kalian menggunakan Valet: http://yourdomain.test/docs
  2. Jika kalian menggunakan Laravel serve: http://localhost:8000

Maka kurang lebih tampilannya seperti berikut ini:


Berikut ini beberapa perusahaan yang sudah menggunakan LareCipe di beberapa produk mereka:

  1. Zino
  2. Blogged
  3. WooSignal

sumber: https://larecipe.binarytorch.com.my/

Blog ini telah dibaca sebanyak 509 kali
Laravel Laravel6 Api Api Documentation Api Doc generator Api Docs Laravel Api Documentation Laravel

Sekilas Tentang Penulis

Fika Ridaul Maulayya
Software Engineer | Blogger | Creator of RubyPedia.com

KOMENTAR

blog comments powered by Disqus