Microsoft Web API Hilfeseite - Wie man Anmerkungen für Parameter erstellt

Question

Vor kurzem habe ich angefangen, mit neuer Web API Hilfe-Seitenfunktionalität zu spielen, die vor kurzem der Web API Vorlage hinzugefügt wurde. Und ich habe eine Notiz, dass einige Spalte "Zusätzliche Informationen" immer "keine" ist.

Nach einiger im Markup-Suche fand ich, dass diese Informationen von Attributen

<td class="parameter-annotations"> 
        @if (parameter.Annotations.Count > 0) 
        { 
         foreach (var annotation in parameter.Annotations) 
         { 
          <p>@annotation.Documentation</p> 
         } 
        } 
        else 
        { 
         <p>None.</p> 
        } 
       </td> 

Aber welche Art von Attribut ankommen sollte ich, zusätzliche Informationen zu füllen verwenden sollten? Danke

Answer 1

Ein Beispiel zum Hinzufügen weiterer Informationen finden Sie unter this site.

Es ist Ihr Modell im Grunde mit Anmerkungen versehen, so in Ihrem Fall wäre es so etwas wie: -

public class Product 
{ 
    /// <summary> 
    /// The id of the product 
    /// </summary> 
    [Required] 
    public int Id { get; set; } 

    /// <summary> 
    /// The name of the product 
    /// </summary> 
    [MaxLength(50)] 
    public string Name { get; set; } 
} 

dem Sie eine Ausgabe wie folgt geben würde: -