Leere Modell Objektbeschreibung auf ASP.NET Web API-Hilfe Seiten

Question

Einführung

ich this tutorial Setup meiner ASP.NET Web befolgt habe API-Hilfe Seiten.

Mit <package id="Microsoft.AspNet.WebApi.HelpPage" version="5.2.3" targetFramework="net452" />

Die Dokumentation scheint in Ordnung zu sein, aber ich bin immer leer Modell Eigentum Beschreibungen.

Sie sind in beiden Controller-Methode/Endpunkt und Modelldetails doc leer.

Controller-Methode Beispiel

/// <summary> 
/// POST: api/remitent 
/// </summary> 
/// <param name="remitent"></param> 
public void Post([FromBody]Remitent remitent) 
{ 

} 

Modell Eigenschaft Beispiel

/// <summary> 
/// First name property summary 
/// </summary> 
[Required] 
[MaxLength(49)]  
public string FirstName { get; set; } 

Ergebnisse

Ich würde erwarten, dass die Eigenschaft Firstname Zusammenfassung des Modells Objektbeschreibung auf Dokumente zu füllen. Stattdessen wird die Beschreibung Spalte leer ist:

---

Wer weiß, wie das zu lösen?

Answer 1

Können Sie Swashbuckle anstelle von Microsoft.AspNet.WebApi.HelpPage verwenden. Ich finde, dass Swashbuckle eine bessere Dokumentation und eine benutzerfreundliche Benutzeroberfläche bietet, um Ihre API zu erkunden. Sie können es auch verwenden, um Ihre API zu testen.

Answer 2

Haben Kommentar- Sie diese Codezeile in Areas/Hilfeseite/App_Start/HelpPageConfig.cs:

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));