Percantik Dokumentasi API mu dengan Swagger
Ribet menulis dokumentasi Web servicemu. gunakan Swagger. swagger merupakan tools yang membantumu membuat dokumentasimu menjadi readable dan painless. selain itu swagger juga terintregasi dengan berbagai macam web framework seperti Flask,Springboot maupun Laravel. dengan menggunakan swagger client dari API mu akan lebih mudah dalam membaca dokumentasimu. untuk lebih lanjut tentang swagger bisa dlihat di official websitenya https://swagger.io
painless dan readable? berikut tampilan dokumentasi menggunakans swagger

Karena akhir-akhir ini saya bermain di spring maka saya akan memberi contoh di springboot. pertama-tama tambahkan dependencynya. disini saya menggunakan Maven
https://gist.github.com/rangga-rizky/5e4faa5deb6e4bfbda4fc99358233cde
Setelah menambahkan dokumentasi. maka selanjutnya adalah membuat file konfigurasi
dari konfigurasi diatas saya rasa bisa dibaca sendiri. Tag digunakan untuk mengelompokan dokumentasi disini Tag saya bagi berdasarkan Resource. kalo yang pernah memakai spring pasti sudah terbiasa menggunakan annotasi . pada Controller kita bisa menambahkan keterang pada setiap endpoint yang ada. contohnya seperti AuthController dibawah ini
@ApiOperation(value = “${UserController.signup}”) untuk memberikan keterangan dari sebuah endpoint, UserController.signup dibaca melalui file application.yml atau bisa juga dibaca dari application.properties

lalu bagaimana hasilnya?? swagger ui dapat diakses melalui http://localhost:8080/swagger-ui.html



Dokumentasi sangat penting sebagai alat komunikasi antara Back-end Developer dan Front-end Developer. dengan dokumentasi yang readable, client akan lebih produktif dan tidak sering-sering mengganggu ktia dan bertanya? endpoint ini formatnya gimana?…
