Cara Convert Swagger ke Slate

Hi guys, kali ini gw akan membahas mengenai slate lagi. Beberapa hari belakangan ini gw mencoba cari cara bagaimana membuat dokumentasi yang bagus namun tidak membuat gw repot. Di tiket.com sendiri sebenarnya sudah ada swagger untuk mempermudah developer dalam mengetes api namun balik lagi itu saja sudah tidak cukup. Lalu kepikiran, bisa gak sih ngubah swagger ke slate? At least simplenya gw ga perlu bikin dari awal lagi. Jawabannya adalah bisa tapi ya semi-semi harus update dikit-dikit. Ibarat orang ujian copas tapi butuh config dikit-dikit.

Yang pertama kali dibutuhkan untuk bisa membuat dokumentasi dari swagger adalah ya swagger itu sendiri. Kalau kalian bingung buatnya, bisa pull project github gw disini. Btw disini gw akan menggunakan java untuk projectnya. Sebagai prasyarat untuk menjalankan project gw adalah sebagai berikut :

  1. JDK 11
  2. Gradle
  3. MongoDB (karena kebetulan gw lagi coba main di mongo).
  4. Intellij IDEA / Eclipse / Netbeans (serius nih hari gini masi pakai netbeans) / notepad++ (sujud sembah ngoding java pakai ini)

Kalau sudah lengkap silahkan jalankan aplikasinya, nanti tampilannya akan seperti ini :

Tampilan Swagger

Yang perlu diperhatikan disini adalah url dibawah Service Name yakni http://localhost:7777/v2/api-docs. Langsung klik url tersebut maka akan keluar seperti berikut :

Nah, silahkan copas text tersebut dan save ke file dengan extension .json. Sebagai contoh disini gw akan memberikan nama sebagai testing.json. Setelah selesai, kita akan pindah dari bermain java menjadi node js. Kenapa pakai nodejs? Karena library yang convert untuk ubah swagger ke slate cuma ada di nodejs (lebih tepatnya gw baru taunya cuma punya nodejs). Apa perlu install nodejs? Terserah kalian, cuma gw bakal ajarin kalian bagaimana cara jalanin nodejs via docker biar kalian ga cupu-cupu bangetlah hari gini. Gimana kalau mau install nodejs? Ya gapapa, kan laptop punya kalian sendiri kalau gw sih ogah (jadi nyinyir wkwk).

Lalu bagaimana dengan command dockernya sendiri?

Buat kalian yang sudah mengerti command docker dan ingin menggunakan versi node yang lain gimana? Silahkan, yang gw tulis diatas cuma contoh. Yang berikutnya adalah kita menginstall sebuah package dari npm yakni swagger-to-slate. Untuk cara kerjanya sebagai berikut :

Inside docker container

Jadi nantinya kalian akan masuk ke docker containernya, lalu install terlebih dahulu packagenya dengan menggunakan global package. Setelah selesai jalankan dengan command swagger-to-slate -i <file-name.json>, kalau dicontohnya adalah testing.json. Untuk hasil generatenya maka akan terbentuk sebuah file bernama testing.md yang isinya seperti berikut.

Lalu untuk testing.md nya bisa dicopaskan ke index.html.md di slatenya. Bagi yang kelewatan bagaimana jalankan docker di slate bisa cek post gw disini. Kalau sudah mengcopy, maka akan hasilnya akan seperti berikut :

Slate Result

Demikian sedikit tutorial dari gw, kalau ada yang bilang ga rapi seperti yang gw bilang sebelumnya butuh namanya update-update dikit tapi at least effortnya ga gede lah.

Leave a Reply