Ana içeriğe atla

Asp.Net Web Api - Swagger Dökümantasyon Alt Yapısı Ekleme

Backend tarafında rest api alt yapısı geliştirirken en büyük problemlerden biri şüphesiz ki bu API endpointlerini kullanacak kişilerle çok iyi iletişim kurabilecek bir dökümantasyon oluşturmak ve tabi bunun yanında kendi apilerini test caseler dışında kod yazmadan minimum efort ile manuel test edecek bir ortam olması.

Daha önce .Net ile Rest Api geliştirirken Microsoft un sunduğu Help Page alt yapısından bahsetmiştim, buraya tıklayarak bu yazıma ulaşabilirsiniz. Microsoft bu tarafta bize her ne kadar hem yardım dökümanı oluşturma ve test edebilme üzerine güzel nuget package lar sunsa da , bu işi daha profesyonel, görsel ve fonksiyonel bir şekilde swagger ile yapabiliyoruz.

Peki .Net Web Api projemizde swagger alt yapısını nasıl kullanabiliriz ?

(Normalde swagger ın .Net e özel nuget ı olsa da uygulaması biraz zahmetli ve uzun olduğu için ben kendi bulduğum kurulumu çok basit bir nuget package üzerinden anlatıyor olacağım.)

Bu işlem oldukça kolay aşağıdaki adımları izlememiz yeterli.
1-) İlk olarak swagger için gerekli xml dökümantasyon sistemini projemizde aktif etme işlemini yapıyoruz.
 Bunun için projemize sağ tuş tıklayarak 'Properties' seçeneğine tıklıyoruz. Ardından 'Build' sekmesine geçip, 'XML Documentation File' check ini işaretliyoruz.

2-) Sonrasında projemize sağ tuş tıklayıp - > 'Manage Nuget Packages' seçeneğine tıklıyoruz.

3-) Browse Sekmesine 'Swashbuckle' yazıp aratıyoruz.

4-) İlk çıkan kayda tıklayıp 'Install' diyoruz.

5-) Ardından projemizi çalıştırıp url ye ek olarak /swagger yazıyoruz.

6-) Ve swagger kütüphanemiz hazır :)


Bu blogdaki popüler yayınlar

SQL DATEADD() Fonksiyonu(Sql de tarihe ay,gün,yıl ekleme)

Kullanım Kalıbı : DATEADD (datepart , number , date ) . datepart ksımına month,year,day vs artırmak istediğimiz tarih birimini yazıyoruz. . number ksımına arttırmak istediğimiz miktarı yazıyoruz. . date kısmına da hangi tarih e ekleneceğini belirtiyoruz. Örnek olarak şu an ki tarihten 1 ay sonrasını görmek için : Şu anki tarih '10-1-2011' olsun(gün,ay,yıl) Sorgu : SELECT DATEADD(MONTH,+1,GETDATE()) Çıktı alacağımız tarih : '10-2-2011' şekinde olacaktır.

Cannot resolve the collation conflict between "Turkish_CI_AS" and "SQL_Latin1_General_CP1_CI_AS" in the equal to operation.

iki ayrı veri tabanı içindeki tablolar ile işlem yapılmak istendiğinde eğer dil sorunu çıkıyor ise sorgumuzun sonuna 'COLLATE TURKISH_CI_AS' sözcüğünü ekleyerek sorunu çözebiliriz.Örnek : SELECT * FROM veritabani1.dbo.URUN u1 INNER JOIN veritabani2.dbo.URUNLER u2 ON u1.kod = u2.kod COLLATE TURKISH_CI_AS umarım faydalı olmuştur.

Logo (LOJECTS.exe ve LOBJECTS.dll) Register İşlemleri

LOBJECTS.dll register işlemi : başlat-> çalıştır -> cmd yazıp konsole ekranına geçiyoruz REGİSTER İÇİN : regsvr32 logoDosyaYolu\LOBJECTS.dll yazıyoruz ve dll imizi register ediyoruz UNREGISTER İÇİN : regsvr32 -u logoDosyaYolu\LOBJECTS.dll ile de unregister edebiliriz. LOBJECTS.exe register işlemi : başlat-> çalıştır -> cmd yazıp konsole ekranına geçiyoruz REGİSTER İÇİN : logoDosyaYolu\LOBJECTS.exe -REGSERVER yazıyoruz ve LOBJECTS.exe mizi register ediyoruz. UNREGISTER İÇİN : logoDosyaYolu\LOBJECTS.exe -UNREGSERVER yazıyoruz ve LOBJECTS.exe mizi unregister ediyoruz. Umarım yararlı olmuştur.