2013-03-28 17 views
8

Bir FromBody parametresi, Kişi türü alan bir post işlemim var. HelpPage'de Kişi paramater hakkında bilgi alıyorum. Bunun yerine Kişiler'deki özellikler hakkındaki bilgileri listelemek ve her özellik için açıklama almak için XML belgeleri dosyasındaki belgeleri kullanmak mümkün müdür?ASP.Net Web API Yardımı Sayfalar: Belge karmaşık yazım özellikleri

public class PersonController : ApiController 
{ 
    /// <summary> 
    /// Add a person 
    /// </summary> 
    /// <param name="person">Person to add</param> 
    /// <returns></returns> 
    [HttpPost] 
    public HttpResponseMessage Add([FromBody] Person person) 
    { 
     // ... 

     return Request.CreateResponse(HttpStatusCode.Created); 
    } 
} 

/// <summary> 
/// A person 
/// </summary> 
public class Person 
{ 
    /// <summary> 
    /// The name of the person 
    /// </summary> 
    public String Name { get; set; } 

    /// <summary> 
    /// The age of the person 
    /// </summary> 
    public Int32 Age { get; set; } 
} 
+0

Şu anda bu kutunun dışında desteklenmemektedir. Bir modelde kullanılan veri açıklama özellikleri için yardım sayfası oluşturulmasını isteyen ilgili bir iş öğesi var. Senaryonuz düzeltildikten sonra çalışmalıdır: http://aspnetwebstack.codeplex.com/workitem/877 –

+0

Teşekkürler! Buraya bir cevap verin ve cevap olarak işaretleyeceğim! –

+0

Bu çalışmayı hiç almadınız mı? /// 'yorumlar? @KiranChalla tarafından bağlı iş öğesi ek açıklama desteği uygulamış görünüyor, ancak Ekim '15 itibariyle dokümanlar hala yardım sayfasında görüntülenmiyor. – Mendhak

cevap

6

Şu anda kutudan desteklenmiyor. Bir modelde kullanılan veri açıklama özellikleri için yardım sayfası oluşturulmasını isteyen ilgili bir iş öğesi var. Senaryonuz düzeltildikten sonra çalışmalıdır: http://aspnetwebstack.codeplex.com/workitem/877

+0

En son sürüm (MVC5 ile birlikte ASP.NET Web API 2.2 kullanıyorum) artık kullanılan veri ek açıklamalarını gösteren oluşturulan yardım dosyalarını içerir. Ayrıntılar için http://www.strathweb.com/2014/01/return-types-action-parameters-and-data-annotations-now-available-in-web-api-2-1-help-page/ sayfasına bakın. – DigitalDan