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.
- @Html.DisplayForModel("TestClientReferences")
Eklenecek Kod :
@Html.DisplayForModel("TestClientDialogs")
@section Scripts{
<link type="text/css" href="~/Areas/HelpPage/HelpPage.css" />
@Html.DisplayForModel("TestClientReferences")
}
