ASP.NET Core Projelerinde Swagger Kurulumu

Arkadaşlar herkese selamlar, bu yazımda ASP.NET Core projenize Swagger kurulumu ve kullanımından bahsedeceğim.

Öncelikle Swagger yazmış olduğunuz api için bir dökümantasyon aracıdır. Sadece dökümante etmekle kalmayıp aynı zamanda yazdığınız api’leri kolay bir şekilde denemenizi ve sonucunu görmenizi sağlar. Bu sayede karşılaştığınız hataları hızlı bir şekilde debug edebilir ve çözebilirsiniz.

Şimdi biraz bahsettikten sonra adım adım ASP.NET Core Web Api projesine Swagger tanımını adım adım yapalım.

İlk olarak ASP.NET Core Api projenize Nuget paket yöneticisi üzerinden Swashbuckle.AspNetCore paketini kuruyoruz.

İkinci adım olarak ise projemizin Startup.cs dosyasındaki ConfigureServices methodu içerisine aşağıdaki kod bloğunu ekliyoruz.

Bu kod blogu ile beraber aslında Swagger’ı projeye tanımlayıp, Swagger dökümantasyonuna ait title ve versiyon bilgilerini de burada set ediyoruz.

Aynı zamanda bu 2 bilginin yanında aşağıdaki fotoğrafta olan bilgileri de bu aşamada set edebiliriz.

Üçüncü adıma geldiğimizde yine Startup.cs dosyası içerisinde bu sefer Configure methodu içerisine aşağıdaki kod bloğunu ekleyerek aslında Swagger ayarlarının okunacağı JSON dosyasını belirtmiş oluyoruz.

Bu sayede konfigurasyon dosyasının okunmasını ve aynı zamanda UseSwagger ile aslında Configure methoduna gördüğünüz diğer ayarlar gibi Swagger çalışır hale getiriyoruz.

Bu ayarları yaptıktan sonra projeyi çalıştırdığımız da “localhost/swagger” dediğimizde Swagger’a ait sayfa açılacaktır.

Ancak son bir ayar olarak geliştirme yaptığımız süre boyunca projenin açılış sayfası olarak “localhost/swagger” adresini tanımlıyoruz. Bunu yapma sebebimiz aslında her proje çalıştığında /swagger ekleyerek sayfaya gitmektense direk yönlendirmesini sağlamaktır. Öncelikle solution’a sağ tıklayıp properties dedikten sonra açılan pencerede Launch Browser kısmına “swagger” yazarak tanımı tamamlıyoruz.

Şimdi projeyi çalıştırdığımızda karşımıza tanımını yaptığımız sayfa aşağıdaki şekilde açılacaktır.

Bu sayfada yer alan My Api ve versiyon bölümü Startup üzerinde tanımladığımız bilgilerdir. Alt kısımda ise başlık olarak yer alan User ise controller yani api tanımlarını ve kodunu yazdığımız dosyayı belirtmektedir.

“[GET] /User” yazan bölüm ise UserController içerisine tanımladığımız HTTP method tipi olarak Get olan User methodunu göstermektedir.

Bu methodun üzerine tıkladığımız aşağıdaki şekilde bir ekran gelecektir.

Bu kısımda ise hem methodun request ve response bilgilerini görebilir, aynı zamanda sağ üst kısımda yer alan Try it out butonu ile de denemesini yapabilirsiniz.

Görmüş olduğunuz gibi Try it out seçeneğine tıkladıktan sonra Execute diyerek aslında tanımladığımız methodun testini yaptık. Yapmış olduğumu çağrının request ve response bilgilerini burada rahatça kontrol edebiliriz.

Aynı zamanda projede kodlarında denediğiniz method için breakpoint koyarak rahatça debug edebilirsiniz.

Sonuç olarak Swagger yazmış olduğunuz api methodlarını hızlıca test etmenizi ve sorunları çözmenizi sağlamakla beraber bir dökümantasyon da sağlamaktadır. Hem projeye yeni katılan hemde test yapan yazılımcılar için swagger kullanımı çok faydalı olacaktır.

Okuduğunuz için teşekkür ederim, paylaşım ve alkışlar motivasyonu artıracaktır :)

Görüşmek üzere :)