Di malam yang sunyi ini, aku sendiri. Eh, ini mau menulis lirik lagukah? Tidaakkk…..

Maafkan ketidakjelasan saya, maklum malam ini saya sedang sendiri di rumah. Istri dan anak saya sedang menginap di rumah mertua.

Lanjut ke inti tulisan aja. Jadi, malam ini saya ingin membagikan ilmu, bagaimana cara menggunakan Swagger sebagai API Helper untuk project API kita. Untuk yang ingin mengetahui lebih lanjut apa itu Swagger, bisa buka link berikut :

https://swagger.io/

Selanjutnya, saya akan menjelaskan langkah-langkah yang perlu dilakukan untuk menggunakan Swagger ini. Sebelumnya perlu diingat, di sini saya coba mempraktekkan penggunaan Swagger untuk project API versi .Net Framework dan saya sendiri menggunakan .Net Framework 4.6.1 untuk tulisan ini. Berikut langkah-langkahnya :

• Buat sebuah Project API, create nama project “API” dan tunggu hingga proses selesai seperti berikut :

• Buka Package Manager Console dan pastikan project yang terpilih adalah project API yang akan dipasang Swagger. Lalu ketikkan perintah Install-Package Swashbuckle kemudian tekan enter. Tunggu hingga proses instalasi paket selesai :

• Pastikan SwaggerConfig sudah ada pada Folder App_Start seperti berikut :

• Buka property Project. Kemudian pilih Build. Aktifkan XML Documentation file dengan memberi tanda centang :

Proses pemasangan sudah berhasil sampai di sini. Selanjutnya kita dapat melakukan testing dengan menjalankan API kita. Dan saat sudah berjalan, kita tambahkan swagger pada path (untuk kasus saya, path menjadi berikut : http://localhost:57897/swagger) sehingga Swagger UI dapat terpanggil seperti berikut :

Jika kita klik pada List Operations, kita akan melihat semua endpoint/fungsi pada API kita dan melakukan testing pada setiap endpoint yang ingin kita tes.

Demikian tutorial singkat saya pada malam ini. Harap dimaklum karena saya juga sepertinya sudah mulai mengantuk (maklum, ternyata sudah berganti hari, hehe…). Semoga tulisan ini bermanfaat khususnya bagi yang sedang mengerjakan project API namun bingung untuk menyiapkan sebuah UI untuk keperluan testing maupun sebagai dokumentasi project.

Nantikan artikel selanjutnya dan terima kasih… 😀