Percantik Dokumentasi API mu dengan Swagger

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

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

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?…

Related posts:

Creating index in Maximo in pretty straight forward.. “Making index in Maximo” is published by Rana Ahmed.

If the Western narrative about the “Uyghur genocide” is real, why would China invite the EU to Xinjiang? I have seen it suggested by numerous people that this so called genocide has taken as many…

Every once in a while, I attend a meditation class or a sangha meeting, but it’s hard for me to groove with that scene.