Ana içeriğe atla

Asp.Net Web API Help Page ve Help Page Simple Test Eklentisi

Asp.Net Web Api - Help Page Sayfası Ekleme

Asp.Net Web API projelerimizde genellikle geliştirdiğimiz api parametre, link ve diğer detayları hakkında dökümantasyon yapmamız gerekir. Bu dökümantasyonu rest api endpoint lerini kullanacak departman, yada kişilere ieltiriz.

Bizi bu dökümantasyon zahmetinden kurtarmak için microsoft otomatik olarak yazdığımız apilerin dökümantasyonunu yapan bir "help page" alt yapısı geliştirmiş. İlgili alt yapıyı kullanarak web api dökümantasyonu sağlamak için sırası ile aşağıdaki işlemleri yapmamız yeterlidir.

Aşamalar

1.Visual Studio da projemizi açıyoruz.
2.Visual Studio "Tool" menüsünden NuGet Package Manager -> Package Manager Console u açıyoruz.
3.Bu alt kısımda açılan console ekranında aşağıdaki komutu yazıp enter a basıyoruz.

C# Projesi için  :

Install-Package Microsoft.AspNet.WebApi.HelpPage


Visual Basic Projesi için :

Install-Package Microsoft.AspNet.WebApi.HelpPage.VB

4. İşlem tamamlandığında Visual Studio Solution 'da root dizinde "Areas/HelpPage" dizini oluşmuş olacak. Bunun anlamı yükleme işlemimiz başarıyla tamamlandı demek oluyor.

5. Son olarak projenizde Asp.Net MVC alt yapısı da kullanmıyor iseniz Global.asax dosyanıza aşağıdaki kodu eklemeniz gerekiyor.


Eklenecek Kod :

protected void Application_Start() {

AreaRegistration.RegisterAllAreas();

 }

Not : Muhtemelen Application_Start metodu vardır Global.asax dosyanızda sadece içindeki kısmı eklemeniz yeterlidir.


Karşımıza aşağıdaki gibi bir ekran gelecektir.


Yukarıdaki görselde ben sadece login ve register apileri eklemiştim ilgili apileri görebiliyoruz. Üzerlerine tıkladığımızda api parametre ve açıklamalarını da görebiliriz.


Asp.Net Web Api - Help Page Simple Test Eklentisi Ekleme

Test Client Eklentisini Yükleyelim

Asp.Net Web Api projemiz üzerinde sağ tuş tıklayarak , "Manage Nuget Packages" seçeneğini seçiyor ve artından "WebApiTestClient" kelimesini aratıyoruz. Çıkan ekrandan "Web Api Test Client" eklentisini yüklüyoruz. İlgili ekran aşağıdaki gibi olmalıdır.




İlgili eklentiyi ekledikten sonra aşağıdaki dosyalar projemize yüklenmiş olacak; 
 - Scripts\WebApiTestClient.js
 - Areas\HelpPage\TestClient.css
 - Areas\HelpPage\Views\Help\DisplayTemplates\TestClientDialogs.cshtml
 - Areas\HelpPage\Views\Help\DisplayTemplates\TestClientReferences.cshtml


Test Client Eklentisini Web Api Help Page Alt Yapısına Ekleyelim

Areas\HelpPage\Views\Help/Api.cshtml dosyasını açıyor ve aşağıdaki iki parça kodu aşağıdaki resimdeki görüldüğü gibi ekliyoruz. (Resimdeki seçili kısım gibi en alta ekleme yapılmalı)

 - @Html.DisplayForModel("TestClientDialogs")
 - @Html.DisplayForModel("TestClientReferences")

Eklenecek Kod :

@Html.DisplayForModel("TestClientDialogs")

@section Scripts{
<link type="text/css" href="~/Areas/HelpPage/HelpPage.css" />
@Html.DisplayForModel("TestClientReferences")
 }


Bu ekleme sonrasında artık tüm web api metodlarımızın detay sayfalarında test butonu çıkacak ve api metodlarımızı rahatca test edebileceğiz. Son ekran aşağıdaki gibi olacaktır.





Bu blogdaki popüler yayınlar

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.

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.

Microsoft SQL Server, Error: 18456

sql server da authentication sorunu. genelde sql server kurulumundan sonra sql serverda bir kullanıcı açıldığında şifre ve kullanıcı adı girmenize rağmen girişi kabul etmez. bu durumda önce kullanıcınızın properties status kısmından enabled olup olmadığına bakın. eğer bu enable ise sql server sunucu üzerinde sağ tuş yapıp properties 'den Security sekmesinden "Sql Server And Windows Authentication Mode" seçilmeli ve ardından sql server servisleri yeniden başlatılmalıdır değişikliklerin kayıt edilmesi için. işte sql server artık hem windows authentication ile hemde sql authentication ile çalışabilir artık. Umarım faydalı olur.