2013-03-28 14 views
8

Ho un'azione successiva che riceve un parametro FromBody di tipo Person. In HelpPage ricevo informazioni sul parametro Person. È possibile elencare invece le informazioni sulle proprietà in Persona e utilizzare la documentazione dal file di documentazione XML per ottenere descrizioni per ciascuna proprietà?Pagine di aiuto dell'API Web ASP.Net: proprietà del tipo di documento complesso

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

Attualmente questo non è supportato immediatamente dalla confezione. Esiste un elemento di lavoro correlato che richiede la generazione della pagina di aiuto per gli attributi di annotazione dati utilizzati su un modello. Il tuo scenario dovrebbe funzionare afters è fisso: http://aspnetwebstack.codeplex.com/workitem/877 –

+0

Grazie! Rispondi qui e lo contrassegnerò come risposta! –

+0

Hai mai funzionato con commenti '///'? L'elemento di lavoro collegato a @KiranChalla sembra aver implementato il supporto delle annotazioni, ma a partire dal 15 ottobre i documenti non vengono ancora visualizzati nella pagina della guida. – Mendhak

risposta

6

Attualmente ciò non è supportato dalla scatola. Esiste un elemento di lavoro correlato che richiede la generazione della pagina di aiuto per gli attributi di annotazione dati utilizzati su un modello. Lo scenario dovrebbe funzionare afters corretto: http://aspnetwebstack.codeplex.com/workitem/877

+0

L'ultima versione (sto utilizzando ASP.NET Web API 2.2 insieme a MVC5) ora include i file della guida generati che mostrano le annotazioni dei dati utilizzate. Vedi http://www.strathweb.com/2014/01/return-types-action-parameters-and-data-annotations-now-available-in-web-api-2-1-help-page/ per i dettagli. – DigitalDan

Problemi correlati