Swagger ignoriert XML-Parameter-Tag

Question

Ich verwende Swagger + XML-Kommentar-Datei für meine Asp.net Webapi-Dokumentation.

Der Wert im Summary-Tag wird angezeigt, aber das Param-Tag wird ignoriert.

Ich habe eine OdataController v4

// GET: api/L_controller('L') 

    /// <summary> 
    /// This is my summary 
    /// </summary> 
    /// <param name="key">This is my Description</param> 

    [EnableQuery] 
    public IEnumerable<L_model> GetL_controller([FromODataUri] string key) 
    {   
     return someResult; 
    } 

Was mache ich falsch? nichts falsch mit Ihrem Code

Answer 1

Es scheint, es ist, aber es ist ein Fehler in Swashbuckle.Odata: https://github.com/rbeauchamp/Swashbuckle.OData/issues/73

"Key param-Handler überschreiben xml-doc Dokumentation kommentiert"

Ich habe das beobachtet gleiches Problem. Jedes Mal, wenn ich einen Schlüssel verwenden (das Unternehmen Feld kommentierte mit [key]) ist die Beschreibung nur

Schlüssel: Code

(-Code ist der Name des Schlüsselfeldes in meiner Einheit)

Die documantation von andere, nicht-key Parameter funktioniert gut. Eine Abhilfe eine Bemerkungen Tag zu Ihrer Dokumentation hinzufügen könnte dem Sie eine Notiz über den Parameter hinzuzufügen verwenden, zB:

/// <summary> 
/// retrive user by key 
/// {URL}/User(key) 
/// </summary> 
/// <remarks>this documentaion will be displayed</remarks> 
/// <param name="key">this documentation will be ignored</param>