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.

Sql IDENTITY_INSERT Kullanımı

Sql de bazen veri taşıma veya benzeri bir durumda aktarmak istediğimiz tablo kayıtlarını identity field olan ID leri ile aktarmak isteriz.Fakat sql server buna izin vermez.Bu Identity alana insert işlemi için aşşağıdaki gibi bir işlem uygulayabiliriz. Örnek Olarak aşşağıdaki sorguda eski tablomuza yeni başka bir tablo kayıtlarını aynen aktarıyoruz. SET IDENTITY_INSERT tabloadı ON -- identity insert yapılabilir konuma geliyor INSERT INTO eskiTablo SELECT * FROM yeniTablo SET IDENTITY_INSERT tabloadı OFF -- identity insert yapılamaz konumuna geliyor

Netsis NetOpenX50 Nesnesini C# Visual Studio Üzerinde Çalıştırma

Netsis ile sipariş, ürün, fiyat, stok entegrasyonları yaparken NetOpenX apisini kullanmamız gerekiyor. Netsis kullanan bir firma ile entegrasyon geliştirmeden önce yapmamız gereken şey firmanın netopenx api lisansı alıp almadığını öğrenmeliyiz.Bunu onaylattıktan sonra Visual Studio projemize NetOpenx50 dosyasını referans olarak eklemek kalıyor. Projemize referans eklemek için öncelikle NetOpenX50.dll ini bilgisayarımıza indiriyoruz.Ardından komut sataırına girerek aşağıdaki komutu vermeliyiz. regsvr32 C:\Netsis\NetOpenX50.dll Bu işlem sonrasında NetOpenX50 dosyamızı com objesi olarak işletim sistemimize kayıt etmiş oluyoruz. Hemen ardından visual studio projemizi açarak projenin üzerinde References kısmına sağ tuş tıklayarak yeni referens ekle diyoruz.Ardından çıkan pencereden sol panelden COM objelerini seçiyoruz ve orada "NetOpenX50 Kütüphanesi" alanı zaten çıkıyor ve direk seçip referans olarak projemize ekleyebiliyoruz. NetOpenX50 apisinin kullanımı için her d...