Bu makale makine çevirisi ayna makalesidir, orijinal makaleye geçmek için lütfen buraya tıklayın.

Görünüm: 20232|Yanıt: 0

[WebAPI] webAPI otomatik olarak yardım dokümantasyonu oluşturur

[Bağlantıyı kopyala]
Yayınlandı 6.10.2016 15:08:16 | | | |
Daha önce projede arayüzler sağlamak için webapi'yi kullanıyordum ve projede webapi yöntemleri ve yorumlarına göre otomatik yardım belgeleri oluşturulduğunu fark ettim; ayrıca çok güçlü olan webapi yöntemlerini de test edebilirsiniz, şimdi bunları sizinle paylaşacağım.
Önce oluşturulan webapi dokümantasyonuna göz atın.
1. Aşağıdaki şekil, Değerler denetleyici olduğu ve API'nin altındaki listede http yöntemi (Get, POST vb.), talebin eylemi ve yöntemin açıklaması olan oluşturulma yardım belgesinin üst sayfasını göstermektedir.
2. Aşağıdaki şekilde gösterildiği gibi API yönteminin detaylar sayfasını açmak için kırmızı kutudaki bağlantıya tıklayın.
3. Aşağıdaki sayfayı açmak için Test API'sine tıklayın

4. Parametreleri girin, Gönder butonuna tıklayın, aşağıdaki sayfayı açın ve iade değerini görebilirsiniz.

Kurulum adımları şunlardır:
Geliştirme ortamı VS2012 + MVC4 + WEB API
1. Web API Test İstemcisine NuGet üzerinden referans verin

DLL'ye referans vermek böyle bir dosya üretir:
Bu bizim yardım dokümantasyon arayüzümüz


2. Proje özelliklerinde aşağıdaki ayarları yapın, XMl belge dosyasını kontrol edin ve yolu ayarlayın
3. Projenin App_Data klasörü altında bir XmlDocument.xml oluşturun
4. AreasHelpPageApp_StartHelpPageConfig.cs dosyasını açın ve aşağıdaki kod yorumlarını iptal edin

Projeyi çalıştırın, http://localhost:3619/Help'yi açın ve otomatik olarak oluşturulan API belgesini görebilirsiniz; bu da makalenin bir görüntüsü

Proje İndirme:

WebAPIHelper.part2.rar (893.15 KB, İndirme sayısı: 1) WebAPIHelper.part1.rar (1.5 MB, İndirme sayısı: 0)




Önceki:SS-panel v3 çalıştırıyor python servers.py hatası
Önümüzdeki:Sağ tıkla, F12 ile bloklayın ve kaynak kodunu görmekten kaçının
Feragatname:
Code Farmer Network tarafından yayımlanan tüm yazılım, programlama materyalleri veya makaleler yalnızca öğrenme ve araştırma amaçları içindir; Yukarıdaki içerik ticari veya yasa dışı amaçlarla kullanılamaz, aksi takdirde kullanıcılar tüm sonuçları ödemelidir. Bu sitedeki bilgiler internetten alınmakta olup, telif hakkı anlaşmazlıklarının bu siteyle hiçbir ilgisi yoktur. Yukarıdaki içeriği indirmeden sonraki 24 saat içinde bilgisayarınızdan tamamen silmelisiniz. Programı beğendiyseniz, lütfen orijinal yazılımı destekleyin, kayıt satın alın ve daha iyi orijinal hizmetler alın. Herhangi bir ihlal olursa, lütfen bizimle e-posta yoluyla iletişime geçin.

Mail To:help@itsvse.com